Appendix
Details on fields found across our Single Payout API, Batch Payouts API and the Payment Item Search. This page particularly focuses on fields which have a preset range of accepted values.
Single Payout API (V2) request values
| Field name | Accepted values |
|---|---|
transactionTypeCode | TT01 (Customer to Customer) TT02 (Business to Business) TT03 (Customer to Business) TT04 (Business to Customer) TT05 (Return) TT08 (Customer to Government) TT06 (Reversal) TT07 (Government to Government) TT09 (Business to Government) TT10 (Tax) TT99 (Other) |
channel | ACH, WIRE, FP, SEPA, LOCAL, INTERNAL |
beneficiaryAccountTypeCode | AC01 (Checking) AC02 (Savings) AC03 (Money market) AC04 (Certificate of Deposit) AC05 (Vista) AC99 (Other) |
partyTypeCode | PT03 (Beneficiary) PT01 (Remitter) |
typeCode | PD01 (Company) PD02 (Individual) |
titleCode | TI01 (Ms) TI02 (Miss) TI03 (Mr) TI04 (Mrs) TI05 (Dr) TI06 (Mx) TI99 (Misc.) |
identityTypeCode | ID01 (Passport) ID02 (National ID) ID03 (Driver Licence) ID04 (Work Permit) ID05 (Employment Pass) ID06 (Student Pass) ID07 (Permanent Resident Card) ID09 (Company Registration Number) ID10 (Company VAT Number) ID11 (Citizenship Card) ID12 (Tax ID) ID13 (National Insurance) ID99 (Other) ID15 (Legal Identity Card) ID16 (Tax Registration Code) |
addressTypeCode | AD01 (Home) AD02 (Business) AD03 (PO Box) AD99 (Other) |
residentialStatusCode | RS01 (Resident) RS02 (Non Resident) RS99 (Other) |
paymentState | NEW VALID AWAITING_EXECUTION EXECUTED COMPLETED REJECTED REVERSED INVALID FAILED CANCELLED |
Payment state values
paymentState value | Description | Next action |
|---|---|---|
AWAITING_EXECUTIONNEWVALIDREJECTED | Interim states in the asynchrounous payout request. | Please contact your Relationship Manager if any of those states persist as this might suggest integration issues. |
EXECUTED | The API has accepted your payout request and it is now waiting in the queue for submission to our banking partner. | COMPLETED or REVERSED |
COMPLETED | Our banking partner has accepted the payout request for processing. | Final state or REVERSED in a return scenario. |
REVERSED | Our validation rules, banking partner or beneficiary bank has rejected the payout request. The funds have subsequently been returned to your account. All rejected payouts include a description with reasoning (if available). | Final state |
FAILEDINVALID | Final states in the asynchrounous payout request. | Please contact your Relationship Manager if any of those states persist as this might suggest integration issues. |
Purpose of payment code values (V2)
| purposeOfPaymentCode | Description |
|---|---|
| WPPAYR | Payment of payroll |
| WPPENS | Pension payment |
| WPFAMT | Family maintenance |
| WPUBIL | Payment to common utility provider |
| WPSTDY | Payment of study/tuition costs |
| WPTAXS | Payment of taxes |
| WPGDDS | Purchase sale of goods |
| WPCHAR | Payment for charity reasons |
| WPMDCS | Payment for medical care services |
| WPSAVS | Payment to savings/retirement account |
| WPPROP | Payment of property purchase |
| WPSCVE | Purchase sale of services |
| WPSHAR | Payment of shares |
| WPIVST | Payment of an investment (interest) |
| WPTKAG | Tourism (Invoiced Tickets/Travel Agency costs) |
| WPTOUR | Tourism (other) |
| WPREMT | Remittances |
| WPMOVR | Payment of movable property rental |
| WPSUPP | Supplier payment |
| WPCAPI | Payment of capital contribution |
| WPCHRG | Charges/Fees |
| WPTRAN | Payment for transportation |
| WPSALR | Payment for salaries |
| WPDIVD | Dividends |
| WPLOAN | Loans |
| WPISER | Payment of insurance services |
| WPFSER | Payment for financial services |
| WPCARD | Card payments |
| WPRENT | Rental payments |
| WPEXPE | Payment of expenses |
| WPTRNF | Transfer of funds |
| WPBONS | Bonus/compensation |
| WPOTHR | Other |
Special characters
| Field Name | Accepted Values |
|---|---|
| List of accepted Special Characters (CallerId) | .- |
| List of accepted Special Characters for AN fields (including space) | +=%!£$^&*()-_<>@{}[]~#:;',.?/¬`\\| |
Note
Please note that only double backslash is allowed.