Pay with Alternative Payment Method
To get paid with Alternative Payment Method (APM), the first step is to initiate a payment on Craftgate. Afterwards, the payment will be completed by following the payment steps of the APM, which may vary depending on the selected APM. Later, the merchant is triggered with the payment status information who has been given callback URL address in the payment initiation request.
Payment initiation with APM
URL
The endpoint and http method information to make a payment with APM are stated below.
Payment initiation request parameters
See: Alternative Payment_Methods Alternative Payment Method type
ID of Alternative Payment Method which is declared in APM Management Page of Merchant Panel. It is recommended to sent if multiple APM declared in same APM Type.
"boomerang" value that can be sent with the request and received with the response. It can be used to associate different requests with each other. Usually, the order number is used that is stored in merchant own system.
It is generally used as a payment order number or basket number on the merchant side. You can search with this value later by using reporting services.
Total basket price. The sum of the item prices in the basket must be equal to total basket price.
The final amount to be paid from the card by calculating differences such as commissions and discounts. The amount to be collected from the wallet is also included in this amount. If there is an interest in the transaction, the amount with the interest added should be entered in this parameter.
ID of the buyer that is returned from member creation.
It is generally used to keep information specific to the payment channel on the merchant side. You can search with this value later by using reporting services.
The URL to be used to send the result returned from the APM to the merchant
Order id parameter to be transmitted to the APM when receiving the payment. Since it is optional, it is recommended not to send it and the orderId value is generated by Craftgate.
Unique user id that is given from Altervative Payment Provider's system
Additional parameters related to payment.
IP of the buyer.
Payment items related to payment. You must send at least one payment item and the sum of prices must be equal to the price field.
Response Parameters
The parameters returned as a result of the payment transaction with APM are subject to the rules specified in the
Response Formats section of the API documentation home page. In the absence of a systematic or
fictional error, the sub-parameters of the object returned in the data parameter are as follows:
Payment Id
Represent payment status
Sometimes you should do another step for complete APM payment. There is no any step when additionalAction is NONE. For more information, see. APM Additional Actions
Redirect URL of the APM
Detail information of the error, if the payment received an error.
Parameters Forwarded to Callback URL
The following parameters are forwarded as form variables using the HTTP POST method. The parameters included in the
request to callbackUrl by Craftgate after validation are as follows:
Represents APM verification status. Returns SUCCESS or FAILURE.
Value of theconversationId parameter sent in the 3DSecure payment initiation
ID of the payment which is sent when the verification is successful.
Sent as a parameter, in case the APM or end user triggers the 3DS verification step again and the payment has been verified before. Status parameter will be FAILURE and callbackStatus parameter will be ALREADY_RETURNED. In case this field comes with the value of ALREADY_RETURNED, the status of the payment should be checked in your system and no action should be taken if it is completed.
Response parameters hash value with Sha-256 Hex algorithm. You can find details below on "Creating Hash Value".
Creating Hash Value
You can make hash validation response with your hash value. You need to use Sha-256 Hex Algorithm to create hash value.
- You can reach 32 characters key value from following: Merchant Panel -> Yönetim -> Üye İşyeri Ayarları -> "Üye İşyeri Callback Key"
- You need to prepare input value as in order. Also you need to put "###" as delimiter between parameters.
- For null values please put empty string ("").
threedSecureCallbackKey###status###completeStatus###paymentId###conversationData###conversationId ###callbackStatus
Example of hashing procedure for following response is below. Assume that Üye İşyeri Callback Key value as "merchantCallbackKeySandbox".
{
"status": "SUCCESS",
"conversationId": "456d1297-908e-4bd6-a13b-4be31a6e47d5",
"paymentId": 1,
"callbackStatus": null,
"hash": "3a3f520be02eaca2e689d1db855af3925cbdd8db5f850b2b9e61f7ccb9d997b4"
}
Input value for hashing should be like:
merchantCallbackKeySandbox###SUCCESS###1###456d1297-908e-4bd6-a13b-4be31a6e47d5###
You can hash this value via Sha-256 Hex algorithm with Üye İşyeri Callback Key value. Result must be equal with hash value which contains in response.
Sample Codes
Payment initiation with APM
APM Payment Complete
You should complete APM payment if paymentStatus is WAITING and additionalAction is not equal to NONE returned
to you while initializing APM payment.
URL
The endpoint and http method information to make a payment with APM are stated below.
Payment complete request parameters
Payment id
Additional parameters related to complete payment.
Response Parameters
Parameters returned as a result of payment are also subject to the rules specified in
the Response Formats section of the API documentation home page. In the absence of a systematic
or fictional error, the sub-parameters of the object returned in the data parameter are as follows:
ID of the payment.
See: Payment Status
The detail about errors if any error occurred while APM payment.