POST /rest/checkouts
Updated Nov 18, 20262 min read
POST
/rest/checkoutsRequest Body
| Property | Type | Required | Description |
|---|---|---|---|
api_key | string | Yes | API key of the merchant. |
merchant_name | string | No | Displayed merchant name in the checkout page. Defaults to merchant's account name. |
order_id | string | Yes | Order ID for the checkout. |
reference | string | No | Reference for the checkout. |
description | string | No | Description about the product or a service. |
currency | string | No | 3 letter ISO code for the currency. E.g EUR |
amount | number | Yes | Subtotal amount before taxes and shipping. |
total_amount | number | Yes | Total amount after taxes and shipping. Total amount must be equal to the sum of amount, amount_taxes and amount_shipping. |
amount_taxes | number | No | Amount for the taxes occurred. |
amount_shipping | number | No | Amount for shipping charges. |
collect_dob | boolean | No | Collect Date of Birth information. May be required if risk checks are configured in your account. |
collect_phone | boolean | No | Collect phone number from the customer |
collect_gender | boolean | No | Collect Gender information. May be required if risk checks are configured in your account. |
display_manual_payment_instruction_to_customer | boolean | No | Should we display payment instructions to the customer? This may be required for payments made with Purchase on Account/Invoice where customer must send the payment manually. |
payment_instruction_merchant_account_holder | string | No | Account Holder of the merchant. This may be required for payments made with Purchase on Account/Invoice where customer must send the payment manually. |
payment_instruction_merchant_iban | string | No | IBAN of the merchant. This may be required for payments made with Purchase on Account/Invoice where customer must send the payment manually. |
payment_instruction_merchant_bic | string | No | BIC of the merchant. This may be required for payments made with Purchase on Account/Invoice where customer must send the payment manually. |
success_url | string | No | Success URL which customer should be redirected to after the payment process. If not given, success URL will be provided by the payment gateway. |
error_url | string | No | Error URL which customer should be redirected to after the payment process. If not given, error URL will be provided by the payment gateway. |
postback_url | string | No | Postback URL which transactions created through this checkout should send notifications to. If not given, you will not be receiving status updates through webhooks for these transactions. |
display_transaction_details | boolean | No | Display transaction information in the checkouts. |
prefill_customer_info | object | No | Optional parameters to be passed to fill in customer data in the Checkout page. See below for parameters accepted for this object. |