Sign in

v1

latestOpenAPI 3.1.02026-07-26290133.2 KB

Create Payout

Create a new payout to an external account. A Beneficiary will need to be created before a payout can be made using this endpoint.

post/transactions/bank-payouts

Headers

idempotency-keystring

Optional header for retrying requests without accidentally creating the same transaction twice.

Request body

accountIdstring required

id of the Account from where the payout will be made. e.g.cWc4SktyWlkxM0hwcmdYe6FMdXRSQT09

beneficiaryIdstring required

id (UUID) of the bank beneficiary to who the payout will be made.

paymentTypestring

Type of payment that the beneficiary will receive.<br>See Supported Payment Types

referencestring required

Transaction reference to be sent to the beneficiary bank. The reference will appear on the beneficiary bank statement.

paymentDatestring

Future date on which the payout should be executed.<br>YYYY-MM-DD e.g. 2022-04-29

reasonCodestring

Payout Reason Code if required for the selected paymentType

purposeCode'ACCT' | 'ADCS' | 'AGRT' | 'ALMY' | 'AREN' | 'BENE' | 'BECH' | 'BKFE' | 'BKIP' | 'BKPP' | 'BLDM' | 'BONU' | 'BOCE' | 'BEXP' | 'BNET' | 'CBTV' | 'CBLK' | 'CASH' | 'CHAR' | 'CDBL' | 'CLPR' | 'CMDT' | 'COLL' | 'COMM' | 'COMP' | 'COMC' | 'COMT' | 'CORT' | 'CPYR' | 'CSDB' | 'DEPT' | 'DERI' | 'DBTC' | 'DIVD' | 'DNTS' | 'EDUC' | 'ELEC' | 'EPAY' | 'ESTX' | 'ECPR' | 'EXTD' | 'FEES' | 'FORW' | 'FREX' | 'FAND' | 'FUTR' | 'FNET' | 'FXNT' | 'GAMB' | 'GASB' | 'GDSV' | 'GIFT' | 'GOVT' | 'GSCB' | 'HEDG' | 'HLRP' | 'HLST' | 'HLTI' | 'HREC' | 'HSTX' | 'INPC' | 'INPR' | 'INSC' | 'INSU' | 'INSM' | 'INTE' | 'INTC' | 'INTP' | 'INVS' | 'INTX' | 'IVPT' | 'LICF' | 'LBRI' | 'LIFI' | 'LIMA' | 'LOAN' | 'LOAR' | 'LOTT' | 'LREB' | 'LREV' | 'LTCF' | 'MDCS' | 'NETT' | 'OTCD' | 'PEFC' | 'PENO' | 'PDEP' | 'PENS' | 'PCOM' | 'PHON' | 'PLDS' | 'PLRF' | 'PPTI' | 'PTXP' | 'REFU' | 'RELG' | 'RENT' | 'REOD' | 'REPO' | 'REBT' | 'ROYA' | 'RDTX' | 'SALA' | 'SBSC' | 'SECU' | 'SERV' | 'SAVG' | 'SLEB' | 'SSBE' | 'SUBS' | 'SUPP' | 'SWFP' | 'SWPP' | 'SWRS' | 'SWUF' | 'TAXR' | 'TAXS' | 'TCSC' | 'TREA' | 'TRAD' | 'TRFD' | 'UBIL' | 'VATX' | 'VIEW' | 'WHLD' | 'WTER'

Applicable for SWIFT and CHAPS GBP payments. See Supported Purpose Codes

Response

200

idstring
shortIdstring
accountIdstring
createdDatestring
updatedDatestring
paymentDatestring
transactionIdstring
transactionCategorystring
typestring
paymentTypestring
{"stackTrail":"paths:/transactions/bank-payouts:post:responses:200:content:application/json:schema:properties:source","oasType":"schema","type":"unknown"}
destinationstring
{"stackTrail":"paths:/transactions/bank-payouts:post:responses:200:content:application/json:schema:properties:buyAmount","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/transactions/bank-payouts:post:responses:200:content:application/json:schema:properties:fxRate","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/transactions/bank-payouts:post:responses:200:content:application/json:schema:properties:midMarketRate","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/transactions/bank-payouts:post:responses:200:content:application/json:schema:properties:fixedSide","oasType":"schema","type":"unknown"}
statusstring
{"stackTrail":"paths:/transactions/bank-payouts:post:responses:200:content:application/json:schema:properties:failureReason","oasType":"schema","type":"unknown"}
commentstring
{"stackTrail":"paths:/transactions/bank-payouts:post:responses:200:content:application/json:schema:properties:transactionReference","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/transactions/bank-payouts:post:responses:200:content:application/json:schema:properties:referenceAmount","oasType":"schema","type":"unknown"}
accountHolderIdstring
{"stackTrail":"paths:/transactions/bank-payouts:post:responses:200:content:application/json:schema:properties:originalTransactionId","oasType":"schema","type":"unknown"}

Example response

{
  "id": "Qm5TOTRxcmhxK2pnZHpzeDZPZHBRZz09",
  "shortId": "20200803-8EFH4W",
  "accountId": "Um5PN21FczNuMWxCZWlocHE2dXU1Zz09",
  "createdDate": "2020-08-03T13:16:22.700Z",
  "updatedDate": "2020-08-03T13:16:22.700Z",
  "paymentDate": "2020-08-13T12:19:32.600Z",
  "transactionId": "4b5ea64c-cf39-403a-a887-303b66794a92",
  "transactionCategory": "OTHER",
  "type": "PAYOUT",
  "paymentType": "FASTER_PAYMENTS",
  "sourceInfo": {
    "type": "ACCOUNT",
    "identifier": "OHlRaEVFMWRrNHdseDRCNUorOHFRdz09",
    "internalAccountId": "EUR08561376339076"
  },
  "destinationInfo": {
    "type": "BANK",
    "identifier": "dceeb3a5-5b82-4803-87b8-9d6144a98b01"
  },
  "destination": "dceeb3a5-5b82-4803-87b8-9d6144a98b01",
  "totalAmount": {
    "value": 10,
    "currency": "GBP"
  },
  "amount": {
    "value": 10,
    "currency": "GBP"
  },
  "fee": {
    "currency": "GBP"
  },
  "runningBalance": {
    "value": 9929,
    "currency": "GBP"
  },
  "status": "INITIATED",
  "comment": "Salary Payment",
  "accountHolderId": "b70af316-92d4-4621-b395-ea933cd4ac9d"
}