Create an authorization

Authorization API is used to hold due amount without charging it.

Body Params
string
required

API key of the merchant.

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.

string
required

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

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.

float

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

float

Amount for the taxes included in the payment amount.

float

Amount for the shipping costs included in the payment amount.

string

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

string

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

string

IP address of the customer. Providing may improve 3DS approval rates.

string

Transaction ID of the original (first) transaction. Provide it if you are re-authorizing a previosly authorized or a completed payment. You should also provide if you are creating an authorization from a previously registered payment.

int32
Defaults to 0

1 for recurring and 0 for non-recurring.

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.

string

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

string

Address of the customer.

string

Supplementary address of the customer.

string

City of the customer.

string

State of the customer.

string

Postal Code of the customer.

string
required

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

string

First Name of the customer.

string

Last Name of the customer.

string

Email of the customer.

string

Phone of the customer.

string

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

string

VAT ID of the company, in case the payment is made to be paid by a company.

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.

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.

string

Shipping address of the customer.

string

Supplementary shipping address of the customer.

string

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

string

City of the customer's shipping address.

string

Postal code of the customer's shipping address.

string

State of the customer's shipping address.

string

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

string

First name of the customer's shipping address.

string

Last name of the customer's shipping address.

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.

Headers
string
Defaults to application/json

Content-Type of the body of the request.

Response
200
Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here!