Create a payout

post

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

Payouts API is used when merchant would like to perform an outgoing payment to the customer's account.

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 payout. 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 payout. This should the final amount including all the taxes and shipping fees.

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

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

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.

account_holder

string

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

iban

string

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

bic

string

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

pix_key

string

PIX key of the customer. Must be used alongside pix_key_type parameter.

pix_key_type

string

PIX key type of the customer. Must be used alongside pix_key parameter. Allowed values can be found at https://continentalpay.readme.io/reference/list-of-pix-key-types.

Headers

Content-Type

string

Defaults to application/json

Content type of the request body.

Response

200