{
"id": "550e8400-e29b-41d4-a716-446655440003",
"type": "payout",
"status": "sent",
"account_id": "550e8400-e29b-41d4-a716-446655440001",
"amount": "100.50",
"currency": "USD",
"counterparty_id": "550e8400-e29b-41d4-a716-446655440000",
"unstructured_remittance_information": "INV-2026-0042",
"purpose_code": "SALA",
"tracking_reference": {
"type": "uetr",
"value": "550e8400-e29b-41d4-a716-446655440000"
},
"failure": null,
"metadata": {
"invoice_id": "INV-2026-0042"
},
"initiated_at": "2026-01-15T10:30:00Z",
"sent_at": "2026-01-15T10:35:00Z",
"tx_hash": null,
"rail": "ach"
}The payout object
Money sent from one of your accounts to a counterparty, including a transfer to another of your own accounts.
rail: "internal" and moves to sent without going over an external rail. Conversions are not payouts; they have their own conversion object. See Payouts.Unique identifier of the payout.
"550e8400-e29b-41d4-a716-446655440003"
Resource type discriminator.
payout Current status of the payout.
initiated, submitted, sent, failed, returned "sent"
ID of the account that was debited.
"550e8400-e29b-41d4-a716-446655440001"
Amount as a string decimal (e.g. "100.50").
"100.50"
Currency code (ISO 4217 or crypto).
EUR, GBP, USD, USDC "USD"
ID of the counterparty that receives the money.
"550e8400-e29b-41d4-a716-446655440000"
Unstructured remittance information attached to the transfer. Not all rails support this field.
"INV-2026-0042"
Purpose of the payout. Use an ISO 20022 external purpose code unless the beneficiary bank country requires a national code. Only supported on fedwire and swift payouts.
BKDF, BKFE, BKFM, BKIP, BKPP, CBLK, CDCB, CDCD, CDCS, CDDP, CDOC, CDQC, ETUP, FCOL, MTUP, ACCT, CASH, COLL, CSDB, DEPT, INTC, INTP, LIMA, NETT, BFWD, CCIR, CCPC, CCPM, CCSM, CRDS, CRPR, CRSP, CRTL, EQPT, EQUS, EXPT, EXTD, FIXI, FWBC, FWCC, FWSB, FWSC, MARG, MBSB, MBSC, MGCC, MGSC, OCCC, OPBC, OPCC, OPSB, OPSC, OPTN, OTCD, REPO, RPBC, RPCC, RPSB, RPSC, RVPO, SBSC, SCIE, SCIR, SCRP, SHBC, SHCC, SHSL, SLEB, SLOA, SWBC, SWCC, SWPT, SWSB, SWSC, TBAS, TBBC, TBCC, TRCP, AGRT, AREN, BEXP, BOCE, COMC, CPYR, GDDS, GDSV, GSCB, LICF, MP2B, POPE, ROYA, SCVE, SERV, SUBS, SUPP, TRAD, CHAR, COMT, MP2P, ECPG, ECPR, ECPU, EPAY, CLPR, COMP, DBTC, GOVI, HLRP, HLST, INPC, INPR, INSC, INSU, INTE, LBRI, LIFI, LOAN, LOAR, PENO, PPTI, RELG, RINP, TRFD, FORW, FXNT, ADMG, ADVA, BCDM, BCFG, BLDM, BNET, CBFF, CBFR, CCRD, CDBL, CFEE, CGDD, CORT, COST, CPKC, DCRD, DSMT, DVPM, EDUC, FACT, FAND, FCPM, FEES, GIFT, GOVT, ICCP, IDCP, IHRP, INSM, IVPT, MCDM, MCFG, MSVC, NOWS, OCDM, OCFG, OFEE, OTHR, PADD, PTSP, RCKE, RCPT, REBT, REFU, RENT, REOD, RIMB, RPNT, RRBN, RRCT, RRTP, RVPM, SLPI, SPLT, STDY, TBAN, TBIL, TCSC, TELI, TMPG, TPRI, TPRP, TRNC, TRVC, WEBI, IPAY, IPCA, IPDO, IPEA, IPEC, IPEW, IPPS, IPRT, IPU2, IPUW, ANNI, CAFI, CFDI, CMDT, DERI, DIVD, FREX, HEDG, INVS, PRME, SAVG, SECU, SEPI, TREA, UNIT, FNET, FUTR, ANTS, CVCF, DMEQ, DNTS, HLTC, HLTI, HSPC, ICRF, LTCF, MAFC, MARF, MDCS, VIEW, CDEP, SWFP, SWPP, SWRS, SWUF, ADCS, AEMP, ALLW, ALMY, BBSC, BECH, BENE, BONU, CCHD, COMM, CSLP, GFRP, GVEA, GVEB, GVEC, GVED, GWLT, HREC, PAYR, PEFC, PENS, PRCP, RHBS, SALA, SPSP, SSBE, LBIN, LCOL, LFEE, LMEQ, LMFI, LMRK, LREB, LREV, LSFL, ESTX, FWLV, GSTX, HSTX, INTX, NITX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, B112, BR12, TLRF, TLRR, AIRB, BUSB, FERB, RLWY, TRPT, CBTV, ELEC, ENRG, GASB, NWCH, NWCM, OTLC, PHON, UBIL, WTER, BOND, CABD, CAEQ, CBCR, DBCR, DICL, EQTS, FLCR, EFTC, EFTD, MOMA, RAPI, GAMB, LOTT, AMEX, SASW, AUCO, PCOM, PDEP, PLDS, PLRF, GAFA, GAHO, CPEN, DEPD, RETL, DEBT "SALA"
Rail network tracking identifier with its type: UETR for SWIFT, IMAD for Fedwire, or the 15-digit trace number for ACH. Null when unavailable.
Show child attributes
Show child attributes
{
"type": "uetr",
"value": "550e8400-e29b-41d4-a716-446655440000"
}
Failure details when status is failed, otherwise null.
Show child attributes
Show child attributes
null
Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.
Show child attributes
Show child attributes
{ "invoice_id": "INV-2026-0042" }
ISO 8601 UTC timestamp when the payout was initiated.
"2026-01-15T10:30:00Z"
ISO 8601 UTC timestamp when the payout was sent.
"2026-01-15T10:35:00Z"
Transaction hash for crypto payouts, or null when not known. Only blockchain rails support this field.
null
Payment scheme or blockchain used for the payout, or null when unknown.
sepa, sepa_instant, faster_payments, swift, internal, target, ach, fedwire, bitcoin, bitcoin_testnet4, ethereum, ethereum_sepolia, solana, solana_devnet, polygon, polygon_amoy, null "ach"
Was this page helpful?