Sign in

v1

latestOpenAPI 3.1.02026-07-266133267.6 KB

post/payout/{id}/confirm

Path parameters

idstring required

ID of the payout

Request body

sourcestring required

ID of the collect to fund the payout

Response

amountnumber

Amount of the payout in payout currency

balance_transactionstring

ID of the balance transaction associated with this payout

beneficiarystring

Unique identifier of the payout beneficiary

charge_typestring

Type of charge (e.g., shared, ours, beneficiary)

created_atstring

Timestamp when the payout was created

currencystring

Currency of the payout

holding_currencystring

Currency in which funds are held before conversion

idstring

Unique payout ID

metadataMetadata nullable

Custom metadata key-value pairs attached to the object

mt103string

SWIFT MT103 reference number, if applicable

objectstring

Type of object

on_behalf_ofstring

Entity on whose behalf the payout is made

purposestring

Purpose code or reason for the payout

reference_idstring

External reference ID

sourcestring

Source collection ID for the payout

statement_descriptorstring

Statement descriptor shown on recipient’s statement

statusstring

Current status of the payout

status_descriptionstring

Additional status description

{"stackTrail":"paths:/payout/{id}/confirm:post:responses:200:content:application/json:schema:properties:tracking_details","oasType":"schema","type":"unknown","description":"Tracking details if available"}
transaction_descriptionstring

Description or purpose of the payout transaction

typestring

Type of payout (e.g., local, swift)