Sign in

v1

latestOpenAPI 3.1.02026-07-26290133.2 KB

Create Beneficiary Payout

Create a payout without first creating a Beneficiary. A Beneficiary is automatically created using the details from this request.

post/transactions/beneficiaryPayout

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.

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"

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/beneficiaryPayout:post:responses:200:content:application/json:schema:properties:externalCustomerId","oasType":"schema","type":"unknown"}
referencestring
paymentTypestring
reasonCodestring
{"stackTrail":"paths:/transactions/beneficiaryPayout:post:responses:200:content:application/json:schema:properties:bulkPaymentId","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/transactions/beneficiaryPayout:post:responses:200:content:application/json:schema:properties:metadata","oasType":"schema","type":"unknown"}
statusstring
transferTransactionIdstring
transferShortIdstring
endToEndReferencestring

Example response

{
  "transactionId": "591a8712-04f2-4518-9df3-8f81bec1819d",
  "shortId": "20220922-K3QY65",
  "reference": "payment to sweep",
  "paymentType": "SEPA_INSTANT",
  "reasonCode": "PERSONAL",
  "amount": {
    "value": 79,
    "currency": "EUR"
  },
  "beneficiary": {
    "customerType": "CORPORATE",
    "firstName": "Sweep",
    "lastName": "Test",
    "companyName": "Sweep Inc.",
    "beneficiaryCountry": "MT",
    "beneficiaryPostalCode": "58585858",
    "beneficiaryCity": "Malta",
    "beneficiaryAddressLine": "BeneficiaryAddressLineOR3520",
    "bankAccountCountry": "MT",
    "bankName": "SWEEP BANK",
    "bic": "CFTEMTM1",
    "iban": "MT39CFTE28004000000000000001297",
    "bankAccountHolderName": "Sweep Inc."
  },
  "status": "IN_PROGRESS",
  "transferTransactionId": "2ef45493-6594-44ea-9170-647802427f5c",
  "transferShortId": "20220922-PRZFLA",
  "endToEndReference": "9fbac239-a531-4413-890d-9be41784e517"
}