Sign in

v1

latestOpenAPI 3.1.02026-07-26290133.2 KB

Create Exchange Payout

Create a new exchange transaction as well as payout to an external account using a single API. The beneficiary may be created using this endpoint on the fly or an existing one can be used.

post/transactions/exchangePayout

Headers

idempotency-keystring

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

Request body

accountIdstring required

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

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.

beneficiaryIdstring

Bank beneficiary id(UUID format)

externalCustomerIdstring

An optional id generated by you to identify the customer or beneficiary on your system.

reasonCodestring

Payout Reason Code if required for the selected paymentType

metadataobject

Set of key-value pairs that you can attach to the Object. Useful for storing additional, structured information on the Object. e.g your internal ID of your user etc.<br> e.g `"userId":"ABC1234, "userName":"Boris Johnson"

exchangeSourceAccountIdstring required

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

fixedSide'SELL' | 'BUY' required

The side of the exchange currency pair that you wish to fix. You can fix the SELL or BUY side i.e. the source currency or destination account.

exchangeCurrencystring required

The currency to which the amount will be exchanged.

quoteIdstring

The id of the quote for which the exchange will take place.

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

transactionIdstring
shortIdstring
{"stackTrail":"paths:/transactions/exchangePayout:post:responses:200:content:application/json:schema:properties:externalCustomerId","oasType":"schema","type":"unknown"}
referencestring
paymentTypestring
reasonCodestring
{"stackTrail":"paths:/transactions/exchangePayout:post:responses:200:content:application/json:schema:properties:bulkPaymentId","oasType":"schema","type":"unknown"}
metadataobject
statusstring

Example response

{
  "transactionId": "b314a24d-75cf-4c4d-bbc9-a8e65cae122f",
  "shortId": "20230516-VNRREK",
  "reference": "ref",
  "paymentType": "ACH",
  "reasonCode": "PERSONAL",
  "amount": {
    "value": 2.2,
    "currency": "CAD"
  },
  "beneficiary": {
    "customerType": "CORPORATE",
    "companyName": "CAD account",
    "beneficiaryCountry": "CA",
    "beneficiaryPostalCode": "1000",
    "beneficiaryCity": "OTTAWA",
    "beneficiaryAddressLine": "USA LINE 1",
    "bankAccountCountry": "CA",
    "bankAccountHolderName": "CAD account",
    "accountNumber": "336558808224",
    "routingCodes": {
      "CTN": "017700000"
    }
  },
  "status": "IN_PROGRESS"
}