Create a payment

post

https://testapi.continentalpay.com/rest/payment

Payments API is used to collect payments from your customers. Some payment methods require you to redirect the user to an external website while other payment methods respond directly without the need for further actions. See more information in the description below.

Body Params

api_key

string

required

API key of your merchant.

payment_type

string

required

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

required

Order ID of the payment. We suggest to use readable but unique value for this field.

merchant_reference

string

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

float

required

Amount for the payment. This should the final amount including all the taxes and shipping fees.

vat

float

Amount for the taxes included in the payment amount.

shipping_costs

float

Amount for the shipping costs included in the payment amount.

currency

string

required

3 letter currency code. In Brazil, we only support BRL as a valid currency.

postback_url

string

HTTPs URL where you would like to receive webhook/postback notifications. E.g https://yourwebsite.com/postbacks

customer_ip

string

IP address of the customer.

original_transaction_id

string

Transaction ID of the original (first) transaction. Used in subsequent recurring / registered payments in Credit Cards and Direct Debit payments.

recurring

integer

Defaults to 0

1 for recurring and 0 for non-recurring.

locale

string

Defaults to en

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

Any other random data that you would like to associate the transaction with.

address

string

Address of the customer.

address2

string

Supplementary address of the customer.

city

string

City of the customer.

state

string

State of the customer.

postal_code

string

Postal Code of the customer.

country

string

required

2 letter ISO code of the country of the customer. E.g DE

first_name

string

First Name of the customer.

last_name

string

Last name of the customer.

string

Email of the customer.

phone

string

Phone of the customer.

company

string

Company name, in case the payment is made to be paid by a company.

company_vat_id

string

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

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

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

Account holder of the bank account. Required for SEPA Direct Debit transactions.

iban

string

IBAN of the bank account. Required for the SEPA Direct Debit transactions.

bic

string

BIC of the bank account. Only required for non SEPA area bank accounts.

sepa_mandate

string

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

Shipping address of the customer.

shipping_address2

string

Supplementary shipping address of the customer.

shipping_company

string

Name of the company, in case product is shipped to a company.

shipping_city

string

City of the customer's shipping address.

shipping_postal_code

string

Postal code of the customer's shipping address.

shipping_state

string

State of the customer's shipping address.

shipping_country

string

2 letter ISO country code of the customer's shipping address. E.g DE

shipping_first_name

string

First name of the customer's shipping address.

shipping_last_name

string

Last name of the customer's shipping address.

date_of_birth

date

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

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

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

Defaults to 43200

PIX QR codes' expiration time. Defaults to 12 hours. It's suggested to be customized to your application's needs.

tax_id

string

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

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

Defaults to 0

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

date

Invoice date of the transaction. Usually required in Boleto payments to specify the due date of the bill.

Headers

Content-Type

string

Defaults to application/json

Response

200Successful response