# POST /rest/checkouts

POST /rest/checkouts

Request Body

PropertyTypeRequiredDescription

api_keystringYesAPI key of the merchant.

merchant_namestringNoDisplayed merchant name in the checkout page. Defaults to merchant's account name.

order_idstringYesOrder ID for the checkout.

referencestringNoReference for the checkout.

descriptionstringNoDescription about the product or a service.

currencystringNo3 letter ISO code for the currency. E.g EUR

amountnumberYesSubtotal amount before taxes and shipping.

total_amountnumberYesTotal amount after taxes and shipping. Total amount must be equal to the sum of amount, amount_taxes and amount_shipping.

amount_taxesnumberNoAmount for the taxes occurred.

amount_shippingnumberNoAmount for shipping charges.

collect_dobbooleanNoCollect Date of Birth information. May be required if risk checks are configured in your account.

collect_phonebooleanNoCollect phone number from the customer

collect_genderbooleanNoCollect Gender information. May be required if risk checks are configured in your account.

display_manual_payment_instruction_to_customerbooleanNoShould 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_holderstringNoAccount 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_ibanstringNoIBAN 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_bicstringNoBIC of the merchant. This may be required for payments made with Purchase on Account/Invoice where customer must send the payment manually.

success_urlstringNoSuccess URL which customer should be redirected to after the payment process. If not given, success URL will be provided by the payment gateway.

error_urlstringNoError URL which customer should be redirected to after the payment process. If not given, error URL will be provided by the payment gateway.

postback_urlstringNoPostback 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_detailsbooleanNoDisplay transaction information in the checkouts.

prefill_customer_infoobjectNoOptional parameters to be passed to fill in customer data in the Checkout page. See below for parameters accepted for this object.

Responses

200
