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.codeDescription
WPPAYRPayment of payroll
WPPENSPension payment
WPFAMTFamily maintenance
WPUBILPayment to common utility provider
WPSTDYPayment of study/tuition costs
WPTAXSPayment of taxes
WPGDDSPurchase sale of goods
WPCHARPayment for charity reasons
WPMDCSPayment for medical care services
WPSAVSPayment to savings/retirement account
WPPROPPayment of property purchase
WPSCVEPurchase sale of services
WPSHARPayment of shares
WPIVSTPayment of an investment (interest)
WPTKAGTourism (Invoiced Tickets/Travel Agency costs)
WPTOURTourism (other)
WPREMTRemittances
WPMOVRPayment of movable property rental
WPSUPPSupplier payment
WPCAPIPayment of capital contribution
WPCHRGCharges/Fees
WPTRANPayment for transportation
WPSALRPayment for salaries
WPDIVDDividends
WPLOANLoans
WPISERPayment of insurance services
WPFSERPayment for financial services
WPCARDCard payments
WPRENTRental payments
WPEXPEPayment of expenses
WPTRNFTransfer of funds
WPBONSBonus/compensation
WPOTHROther

Special characters

Field NameAccepted 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