v1

latestOpenAPI 3.1.02026-07-266133267.6 KB

Create Payout

This lets you initiate a payout.

post/v3/payout

Request body

amountinteger required

Amount in cents. For example if you want to payout $10.12 pass 1012 as the value. For decimal handling for various currencies, refer to <a href="/API-Reference/appendix/Decimal-Currencies" target="_blank"> the guide here</a>

currencystring required

ISO 4217 standard. This is the payout currency. The amount will be in the payout currency

beneficiarystring

ID of an existing payout beneficiary

holding_currencystring

ISO 4217 standard, in uppercase. This is one of your balance currencies whose balance will fund the payout.

metadatastring json

Set of key-value pairs to attach to the payout object

type'local' | 'swift' | 'wallet' | 'local_payment_network' | 'tazapay_account'

Type of payout - local, swift, wallet, tazapay_account, local_payment_network

charge_type'shared' | 'ours'

For wire transfers only

purpose'PYR001' | 'PYR002' | 'PYR003' | 'PYR004' | 'PYR005' | 'PYR006' | 'PYR007' | 'PYR008' | 'PYR009' | 'PYR010' | 'PYR011' | 'PYR012' | 'PYR013' | 'PYR014' | 'PYR015' | 'PYR016' | 'PYR017' | 'PYR018' | 'PYR019' | 'PYR020' | 'PYR021' | 'PYR022' | 'PYR023' | 'PYR024' | 'PYR025' | 'PYR026' | 'PYR027' | 'PYR028' | 'PYR029' | 'PYR030' | 'PYR031' | 'PYR032' | 'PYR033' | 'PYR034' | 'PYR035' | 'PYR036' required

Reason for payout. Click here for the detailed list.

statement_descriptorstring

Statement Descriptor for the payout

reference_idstring

Reference ID of the payout on your system

transaction_descriptionstring required

Additional Details for the payout

on_behalf_ofstring

ID of the entity the payout is created on behalf of

quotestring

Quote ID from the payout quote API

Response

200

statusstring

messagestring