Multi Payment
Initiating Multi Payments
URL
The endpoint and http method information to initiate payment with multi payment are stated below.
Parameters for Initiating Multi Payments
Unlike other payments, the callbackUrl parameter must be sent for payments to be made via the multi payments and
card information is not expected. The cardUserKey parameter can be filled in so that the relevant user can use the
stored cards. In this context, the parameters required to initiate a payment with the multi payments are as
follows.
"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.
Order id parameter to be transmitted to the banks or alternative payment methods when receiving the payment. Since it is optional, it is recommended not to send it and the orderId value is generated by Craftgate.
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.
See: Payment Phases - For Post Auth See: Post Auth
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 bank to the merchant
Card user key that represents the card holder.
If true, payment form only allows credit card for the payment.
If true, the user can only pay using their stored card. cardUserKey parameter is required, if this parameter is true.
If true, card number that the user is used for the payment will be stored. If this parameter is true, allowOnlyStoredCards should not be sent.
If true or omitted, the delete action appears next to stored cards on the common payment page; only when explicitly set to false is the delete option hidden.
If true, installment options are only valid for the commercial cards.
If true, authorization payment is forced for non credit cards.
If sent as true, the user will not be given the option to save their card.
Information on whether 3DSecure payment is required.
Time to Live (TTL) value in minutes for this initialized request
Ödemeye ilişkin kırılım bilgileri. En az bir kırılım gönderilmesi ve gönderilen kırılımların tutarlarının toplamının price alanına eşit olması zorunludur
(See: Masterpass) If the user is required to pay with Masterpass, the phone number associated with the user's Masterpass must be entered starting with 90. If you do not enter it or if the phone number you entered has not been linked with Masterpass before, the Masterpass tab will not be opened in the payment form.
(See: Masterpass) If the user is required to be able to pay with Masterpass, and the user's Masterpass account has been previously linked with the merchant through an environment other than the Craftgate integration, the userId value used in the link phase.
(See. Payoneer) If the user is required to be able to pay with Payoneer, the unique value associated with the user.
You can manage the payment methods to be displayed on the Payment Form with this parameter. If this parameter is [CARD], payment form accepts only card payment. See all available payment methods (see. Payment methods) . All available payment methods are shown when the parameter never sent.
This is the maximum number of successful payments allowed under the multi payment process.
Additional parameters required for the process can be sent here.
Response Parameters
The parameters returned as a result of the payment transaction with the multi payment 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:
Multi Payment Inquiry
With the token forwarded to the callback URL or webhook call, the result of multi payment can be
queried.
URL
The endpoint and http method information to inquiry multi payment are stated below.
Multi Payment Inquiry Response Parameters
The response to inquiry requests for multi payment is stated below.
Multi Payment ID. Unique identifier that created by craftgate for multi payment.
Multi Payment Status
Multi payment token
Expiry date for multi payment
Total price to be collected
Remaining amount to be collected
conversationId value sent in initial request
externalId value sent in initial request
Payment id values of all payments created with multi payment tokenParçalı ödeme için gerçekleştirilen başarılı ve başarısız tüm ödemelere ait id bilgisi
Sample Codes
You can review the sample codes in the open source Craftgate API clients.