Guides
Setting up mandates
Direct Debit Mandates Verified Mandates PayTo Agreements and Payments Build a client to create mandates offline Supporting mandates set up outside of your product Importing Mandates Blocking mandatesRecurring payments
Taking Subscription payments Taking Instalment payments Variable Recurring PaymentsCombining one-off and recurring payments
Take a first Instant Payment with mandate
 set upSend an outbound payment
Adding a new recipient Initiate an outbound payment Approve an outbound payment Cancel an outbound paymentSetting up mandates / collecting payments
Billing Request with Actions: Setting up a Direct Debit mandate Collecting a Direct Debit payment Billing Request with Actions: Taking an Instant Bank Payment Billing Request with Actions Dual Flow: Taking an Instant Bank Payment and setting up a Direct Debit mandatePurpose codes for Billing Request
VRP Commercial Purpose codes
Values | Description |
|---|---|
bonus_payment | Transaction is the payment of a bonus. |
cash_management_transfer | Transaction is a general cash management instruction. |
card_bulk_clearing | A service that is settling money for a bulk of card transactions, while referring to a specific transaction file or other information like terminal ID, card acceptor ID or other transaction details. |
credit_card_payment | Transaction is related to a payment of credit card. |
trade_settlement_payment | Transaction is related to settlement of a trade, eg a foreign exchange deal or a securities transaction. |
debit_card_payment | Transaction is related to a payment of debit card. |
dividend | Transaction is the payment of dividends. |
deliver_against_payment | Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction. |
epayment | Transaction is related to ePayment. |
fee_collection_and_interest | Transaction is related to the payment of a fee and interest. |
fee_collection | A service that is settling card transaction related fees between two parties. |
person_to_person_payment | General Person-to-Person Payment. Debtor and Creditor are natural persons. |
government_payment | Transaction is a payment to or from a government department. |
hedging_transaction | Transaction is related to the payment of a hedging operation. |
irrevocable_credit_card_payment | Transaction is reimbursement of credit card payment. |
irrevocable_debit_card_payment | Transaction is reimbursement of debit card payment. |
intra_company_payment | Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group. |
interest | Transaction is the payment of interest. |
lockbox_transactions | Transaction is related to identify cash handling via Night Safe or Lockbox by bank or vendor on behalf of a physical store. |
loan | Transaction is related to the transfer of a loan to a borrower. |
commercial | Mobile P2B Payment |
consumer | Mobile P2P Payment |
other_payment | Other payment purpose. |
pension_payment | Transaction is the payment of pension. |
represented | Collection used to re-present previously reversed or returned direct debit transactions. |
reimbursement_received_credit_transfer | Transaction is related to a reimbursement for commercial reasons of a correctly received credit transfer. |
receive_against_payment | Code used to pre-advise the account servicer of a forthcoming receive against payment instruction. |
salary_payment | Transaction is the payment of salaries. |
securities | Transaction is the payment of securities. |
social_security_benefit | Transaction is a social security benefit, ie payment made by a government to support individuals. |
supplier_payment | Transaction is related to a payment to a supplier. |
tax_payment | Transaction is the payment of taxes. |
trade | Transaction is related to the payment of a trade finance transaction. |
treasury_payment | Transaction is related to treasury operations. E.g. financial contract settlement. |
value_added_tax_payment | Transaction is the payment of value added tax. |
with_holding | Transaction is the payment of withholding tax. |
cash_management_sweep_account | Classification: Cash Management. Transaction relates to a cash management instruction, requesting a sweep of the account of the Debtor above an agreed floor amount, up to a target or zero balance. The purpose is to move the funds from multiple accounts to a single bank account. Funds can move domestically or across border and more than one bank can be used. |
cash_management_top_account | Classification: Cash Management. Transaction relates to a cash management instruction, requesting to top the account of the Creditor above a certain floor amount, up to a target or zero balance. The floor amount, if not pre-agreed by the parties involved, may be specified. |
cash_management_zero_balance_account | Transaction relates to a cash management instruction, requesting to zero balance the account of the Debtor. Zero Balance Accounts empty or fill the balances in accounts at the same bank, in the same country into or out of a main account each day. |
crossborder_mi_payments | Transaction to be processed as a domestic payment instruction originated from a foreign bank. |
foreign_currency_domestic_transfer | Foreign Currency Transaction that is processed between two domestic financial institutions. |
cash_in_pre_credit | Transaction is a direct debit for a cash order of notes and/or coins. |
cash_out_notes_coins | Transaction is a direct debit for a cash order of notes and/or coins. |
carrier_guarded_wholesale_valuables | Transaction is a payment towards a Party for the collection of cash by the Cash in Transit company. |
PayTo purpose codes
Values | Description |
|---|---|
mortgage | Mortgage Payments |
utility | Utility Payments |
loan | Loan Payments |
dependant_support | Dependant Support Payments |
gambling | Gambling Payments |
retail | Retail Payments |
salary | Salary Payments |
personal | Personal Payment |
government | Government Payments |
pension | Pension Payments |
tax | Tax Payments |
other | Other Service Payments |
