Sign in

v1

latestOpenAPI 3.1.02026-07-26290133.2 KB

Create Sweep Payout

Create a new payout from a LinkedClient account where the funds are swept from the client's Master Account before the payout is done.

post/transactions/sweepPayout

Headers

idempotency-keystring

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

Request body

sweepSourceAccountIdstring

'id' of the account where the funds are being swept from to the Linked Client Account

linkedAccountHolderIdstring required

holderID of the LinkedClient that owns the account that the payment is to be made from

accountIdstring required

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

beneficiaryIdstring

Specify the 'beneficiaryId' of a previously saved bank beneficiary.

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

endToEndReferencestring
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' | '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' | 'FNET'

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

Response

200

transactionIdstring
shortIdstring
{"stackTrail":"paths:/transactions/sweepPayout:post:responses:200:content:application/json:schema:properties:externalCustomerId","oasType":"schema","type":"unknown"}
referencestring
paymentTypestring
reasonCodestring
{"stackTrail":"paths:/transactions/sweepPayout:post:responses:200:content:application/json:schema:properties:bulkPaymentId","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/transactions/sweepPayout: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"
}