# POST /rest/authorize

POST /rest/authorize

Parameters

NameInTypeRequiredDescription

Content-TypeheaderstringNoContent-Type of the body of the request.

Request Body

PropertyTypeRequiredDescription

api_keystringYesAPI key of the 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.

amountnumberNoAmount 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.

currencystringNo3 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. Providing may improve 3DS approval rates.

original_transaction_idstringNoTransaction 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.

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.

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.

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.

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.

Responses

200
