Create Payout

post

https://api-sandbox.merge.money/v1/account/{account_id}/transaction

Create a new payout request.

This request creates a single outgoing payment on behalf of the company issuing
the request.

The account from which the payment is made must be active and must belong
to the company issuing the request.'

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

The unique identifier (UUID) of the account or which the transaction was posted.

Body Params

amount

string

required

The amount to be transferred from your account.

currency

string

enum

required

The currency in which the payout will be made.

Allowed:

recipient_id

string

required

The unique identifier of the recipient to whom you want to send funds.

reference

string

The payout reference will appear on the transaction statement. For GBP transactions the reference must be from 6 to 18 characters, and for EUR transactions the reference must be from 6 to 140 characters. The reference value cannot be the same characters. The allowed characters in the reference are a-z, A-Z, 0-9, spaces, ampersand (&), hyphen (-), full stop (.), and solidus (/).

client_reference

string

The reference associated with the client.

client_nonce

string

The client nonce, which is a random or semi-random number that is used for achieving idempotency. It is strongly recommended that you send this parameter as part of the create request.

override_vop_check

boolean

Defaults to false

Whether to override Verification of Payee decision that's a part of payment processing.

override_vop_check_id

string

Unique identifier of the VoP check request received in the response.

payment_scheme

string

enum

Defaults to PO_SECT

If required, the client can decide the euro payout_scheme to be used for issuing the instruction. When the payment_scheme is shared in the payload, the Merge EMI routes the payment only through that scheme.

Allowed:

Responses

201201

400400

401401

403403

404404

422422

500500