Continental Payment

New Endpoint

This is your first endpoint! Edit this page to start documenting your API.

Updated Nov 18, 20264 min read

POST /rest/payment

This is your first endpoint! Edit this page to start documenting your API.

Parameters

NameInTypeRequiredDescription
Content-TypeheaderstringNo

Request Body

PropertyTypeRequiredDescription
api_keystringYesAPI key of your merchant.
payment_typestringYesIdentifier for the payment method. See list of payment methods in the following link https://continentalpay.readme.io/reference/list-of-payment-methods.
order_idstringYesOrder ID of the payment. We suggest to use readable but unique value for this field.
merchant_referencestringNoReference for the transaction. If not given, merchant name and the order ID is taken as reference. May be shown in bank statements of the customers. We suggest to use appopirate values for the services or products given.
amountnumberYesAmount for the payment. This should the final amount including all the taxes and shipping fees.
vatnumberNoAmount for the taxes included in the payment amount.
shipping_costsnumberNoAmount for the shipping costs included in the payment amount.
currencystringYes3 letter currency code. In Brazil, we only support BRL as a valid currency.
postback_urlstringNoHTTPs URL where you would like to receive webhook/postback notifications. E.g https://yourwebsite.com/postbacks
customer_ipstringNoIP address of the customer.
original_transaction_idstringNoTransaction ID of the original (first) transaction. Used in subsequent recurring / registered payments in Credit Cards and Direct Debit payments.
recurringintegerNo1 for recurring and 0 for non-recurring.
localestringNoLocale for the payment page. Only used in Credit Card payments where customer is redirected to our payment page. Find supported locales here.
additional_transaction_datastringNoAny other random data that you would like to associate the transaction with.
addressstringNoAddress of the customer.
address2stringNoSupplementary address of the customer.
citystringNoCity of the customer.
statestringNoState of the customer.
postal_codestringNoPostal Code of the customer.
countrystringYes2 letter ISO code of the country of the customer. E.g DE
first_namestringNoFirst Name of the customer.
last_namestringNoLast name of the customer.
emailstringNoEmail of the customer.
phonestringNoPhone of the customer.
companystringNoCompany name, in case the payment is made to be paid by a company.
company_vat_idstringNoVAT ID of the company, in case the payment is made to be paid by a company. Also used as tax ID of the person or the company, in Boleto payments.
success_urlstringNoSuccess URL of your website to redirect customers to upon a successful payment. For payment methods that involve browser redirection such as credit card payments, these URLs are required. The following data is appended to the URL, which is used when redirecting back to the shop’s success or error URLs: order_id,transaction_id.
error_urlstringNoError URL of your website to redirect customers to upon a failed payment. For payment methods that involve browser redirection such as credit card payments, these URLs are required. The following data is appended to the URL, which is used when redirecting back to the shop’s success or error URLs: order_id,transaction_id.
account_holderstringNoAccount holder of the bank account. Required for SEPA Direct Debit transactions.
ibanstringNoIBAN of the bank account. Required for the SEPA Direct Debit transactions.
bicstringNoBIC of the bank account. Only required for non SEPA area bank accounts.
sepa_mandatestringNoSEPA Mandate for the given SEPA Direct Debit payment. Max 35 characters. See implications of using SEPA Direct Debit payment method in the following link.
shipping_addressstringNoShipping address of the customer.
shipping_address2stringNoSupplementary shipping address of the customer.
shipping_companystringNoName of the company, in case product is shipped to a company.
shipping_citystringNoCity of the customer's shipping address.
shipping_postal_codestringNoPostal code of the customer's shipping address.
shipping_statestringNoState of the customer's shipping address.
shipping_countrystringNo2 letter ISO country code of the customer's shipping address. E.g DE
shipping_first_namestringNoFirst name of the customer's shipping address.
shipping_last_namestringNoLast name of the customer's shipping address.
date_of_birthstringNoDate of birth of the customer, in YYYY-MM-DD format. Only used for Invoice and Direct Debit payment methods, when an accompanying risk check is enabled which requires this data.
genderstringNoGender of the customer. M for male, F for female and D for Diverse. Only used for Invoice and Direct Debit payment methods, when an accompanying risk check is enabled which requires this data.
frame_originstringNoDomain of the website that will render our payment page. Only used for Credit Card payments when the redirect link will be rendered in an i-frame.
expire_pix_qr_code_in_secondsstringNoPIX QR codes' expiration time. Defaults to 12 hours. It's suggested to be customized to your application's needs.
tax_idstringNoTax ID of the customer. Mostly used in PIX payments to lock the payment to a certain customer, so that only the given customer can pay the due amount. Must be used alongside tax_id_type parameter
tax_id_typestringNoTax ID type of the Tax ID. Mostly used in PIX payments to lock the payment to a certain person. Available values: CPF or CNPJ
risk_check_approvalstringNoWhen you are using a payment method which has configured risk checks, you will have to pass "1" as value for this parameter. "1" represents the customer agreed for their information to be passed in to the 3rd party risk check provider.
invoice_datestringNoInvoice date of the transaction. Usually required in Boleto payments to specify the due date of the bill.

Responses

200 Successful response