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.
Purpose of payment code values
purposeOfPayment.code | 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.
Invalid ExpandableKeyValuePairs
The following keys are not allowed in the ExpandableKeyValuePairs
:
Key |
---|
payoutTransactionType |
payoutInstrumentId |
payoutInstrumentReference |
beneficiaryPartyId |
remitterPartyId |
debitorPartyReference |