Create a payout

post

https://sandbox.comcarde.com/v1/payouts

Send money to your customers.

Body Params

Details of the payout to be initiated.

psp

string

length ≤ 50

Identifier of the Payment Service Provider (PSP) you wish to route this request to. This is required if your retail channel is configured for more than one PSP.

amount

int64

required

1 to 999999999999999

Amount in a currency to be used for the transaction. In the lowest denomination of the currency of the payment. This means that 1234 in GBP represents £12.34.

currencyCode

string

required

Currency code of the payment (ISO 4217)

recipient

object

required

paymentInstrument

required

Electronic instrument with which end users of payment systems use to transfer funds between accounts at banks or other financial institutions.

reference

string

required

length between 1 and 50

A reference you can later use to identify this payout.

Please use only letters, numbers, spaces and these symbols: '[]()@?!\-/.,_&*:;+=

purpose

string

length ≤ 50

The purpose of this payout

Please use only letters, numbers, spaces and these symbols: '[]()@?!\-/.,_&*:;+=

customerId

string

length ≤ 255

The ID of the customer in your system.

Please use only letters, numbers, spaces and these symbols: '[]()@?!\-/.,_&*:;+=

cashierId

string

For use by BR-DGE Cashier to link the transaction to a particular Cashier instance.

riskInstruments

object

Map of optional risk instrument objects which can be used to pass risk information to PSPs or risk engines

merchantTransactionId

string

length between 1 and 50

Your unique identifier that can be used when a connection issue occurs and you don't receive a paymentId. This is an optional field that can be used when querying GET v1/payments, GET v1/payouts or GET v1/payments/{paymentId}/refunds. We will validate the uniqueness of the merchantTransactionId value per retail channel. If a payment/payout/refund is created with merchantTransactionId abc, no other payment/payout/refund can be created with abc.

The merchantTransactionId is a contract between BR-DGE and a merchant. This field will not be mapped downstream to any PSP.

In the event that you provide a merchantTransactionId in the second (or third) leg of a 3DS payment, we will ignore this value and will only use the value provided in the initial request.

customMetadata

object

Optional custom metadata string fields for the transaction.

Up to 25 fields can be included with the following constraints:

The field name may not be empty or have leading or trailing whitespace, and can consist of upper and lowercase letters, numbers, space, underscore "_", hyphen "-" and single quote "'".

Maximum string length of either field name and field value is 200 chars.

Responses

401

Unauthorized request.

Callback

201Payout request completed successfully.

202The operation has been accepted for processing and the outcome is not yet known. Please refer to the webhook callbacks that are linked to this operation.

409Indicates a request conflict.