New Endpoint
This is your first endpoint! Edit this page to start documenting your API.
Updated Nov 18, 20264 min read
POST
/rest/paymentThis is your first endpoint! Edit this page to start documenting your API.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Content-Type | header | string | No |
Request Body
| Property | Type | Required | Description |
|---|---|---|---|
api_key | string | Yes | API key of your merchant. |
payment_type | string | Yes | Identifier for the payment method. See list of payment methods in the following link https://continentalpay.readme.io/reference/list-of-payment-methods. |
order_id | string | Yes | Order ID of the payment. We suggest to use readable but unique value for this field. |
merchant_reference | string | No | Reference 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. |
amount | number | Yes | Amount for the payment. This should the final amount including all the taxes and shipping fees. |
vat | number | No | Amount for the taxes included in the payment amount. |
shipping_costs | number | No | Amount for the shipping costs included in the payment amount. |
currency | string | Yes | 3 letter currency code. In Brazil, we only support BRL as a valid currency. |
postback_url | string | No | HTTPs URL where you would like to receive webhook/postback notifications. E.g https://yourwebsite.com/postbacks |
customer_ip | string | No | IP address of the customer. |
original_transaction_id | string | No | Transaction ID of the original (first) transaction. Used in subsequent recurring / registered payments in Credit Cards and Direct Debit payments. |
recurring | integer | No | 1 for recurring and 0 for non-recurring. |
locale | string | No | Locale for the payment page. Only used in Credit Card payments where customer is redirected to our payment page. Find supported locales here. |
additional_transaction_data | string | No | Any other random data that you would like to associate the transaction with. |
address | string | No | Address of the customer. |
address2 | string | No | Supplementary address of the customer. |
city | string | No | City of the customer. |
state | string | No | State of the customer. |
postal_code | string | No | Postal Code of the customer. |
country | string | Yes | 2 letter ISO code of the country of the customer. E.g DE |
first_name | string | No | First Name of the customer. |
last_name | string | No | Last name of the customer. |
email | string | No | Email of the customer. |
phone | string | No | Phone of the customer. |
company | string | No | Company name, in case the payment is made to be paid by a company. |
company_vat_id | string | No | VAT 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_url | string | No | Success 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_url | string | No | Error 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_holder | string | No | Account holder of the bank account. Required for SEPA Direct Debit transactions. |
iban | string | No | IBAN of the bank account. Required for the SEPA Direct Debit transactions. |
bic | string | No | BIC of the bank account. Only required for non SEPA area bank accounts. |
sepa_mandate | string | No | SEPA 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_address | string | No | Shipping address of the customer. |
shipping_address2 | string | No | Supplementary shipping address of the customer. |
shipping_company | string | No | Name of the company, in case product is shipped to a company. |
shipping_city | string | No | City of the customer's shipping address. |
shipping_postal_code | string | No | Postal code of the customer's shipping address. |
shipping_state | string | No | State of the customer's shipping address. |
shipping_country | string | No | 2 letter ISO country code of the customer's shipping address. E.g DE |
shipping_first_name | string | No | First name of the customer's shipping address. |
shipping_last_name | string | No | Last name of the customer's shipping address. |
date_of_birth | string | No | Date 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. |
gender | string | No | Gender 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_origin | string | No | Domain 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_seconds | string | No | PIX QR codes' expiration time. Defaults to 12 hours. It's suggested to be customized to your application's needs. |
tax_id | string | No | Tax 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_type | string | No | Tax 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_approval | string | No | When 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_date | string | No | Invoice date of the transaction. Usually required in Boleto payments to specify the due date of the bill. |