💸 Payments
Payment rails & required fields
How to instruct a single transfer
Create the beneficiary
It's recommended (although not compulsory) to create the recipient using Create Beneficiary before instructing a transfer.
Get fees and fields (optional)
If you'd like to show the end customer a preview of the transfer fee and ensure you're showing the right mandatory fields, use Get Transfer Fields & Fees to show this information.
Check purpose codes
Fetch the list of valid purpose codes from Get Purpose Codes so the end customer can select the appropriate code.
Instruct transfer
Create a single transfer using Create Single Transfer, passing the newly created beneficiary id.
Sufficient balance
How to instruct a bulk transfer
Download the template
Get the bulk transfer .XLSX template from Get Bulk Transfer Template.
Populate details
Populate the template with beneficiary and transfer details.
Instruct transfer
Create a bulk transfer using Create Bulk Transfer, uploading the completed template file.
Transfer lifecycle
Purpose codes
| Code | Description |
|---|---|
| ACCT | CASH MANAGEMENT - ACCOUNT MANAGEMENT IN BANK |
| ADVA | ADVANCE PAYMENT |
| AGRT | AGRICULTURAL TRANSFER |
| AIRB | AIR |
| ALMY | ALIMONY PAYMENT |
| ANNI | ANNUITY |
| ANTS | ANESTHESIA SERVICES |
| AREN | ACCOUNTS RECEIVABLES ENTRY |
| BECH | CHILD BENEFIT |
| BENE | UNEMPLOYMENT/DISABILITY BENEFIT |
| BEXP | BUSINESS EXPENSES |
| BOCE | BACK OFFICE CONVERSION ENTRY |
| BONU | BONUS PAYMENT |
| BUSB | BUS |
| CASH | CASH MANAGEMENT - TRANSFER OUTSIDE BANK |
| CBFF | CAPITAL BUILDING |
| CBTV | CABLE TV BILL |
| CCRD | CREDIT CARD PAYMENT |
| CDBL | CREDIT CARD BILL |
| CDCB | CARD PAYMENT WITH CASH BACK |
| CDCD | CASH DISBURSEMENT |
| CDOC | ORIGINAL CREDIT |
| CDQC | QUASI CASH |
| CFEE | CANCELLATION FEE |
| CHAR | CHARITY PAYMENT |
| CLPR | CAR LOAN PRINCIPAL REPAYMENT |
| CMDT | COMMODITIES |
| COLL | COLLECTION PAYMENT |
| COMC | COMMERCIAL PAYMENT |
| COMM | COMMISSION |
| COMT | CONSUMER THIRD PARTY CONSOLIDATED PAYMENT |
| COST | COSTS |
| CPYR | COPYRIGHT |
| CSDB | CASH DISBURSEMENT |
| CSLP | COMPANY SOCIAL LOAN PAYMENT TO BANK |
| CVCF | CONVALESCENT CARE FACILITY |
| DBTC | DEBIT COLLECTION PAYMENT |
| DCRD | DEBIT CARD PAYMENT |
| DEPT | DEPOSIT |
| DERI | DERIVATIVES |
| DIVD | DIVIDEND |
| DMEQ | DURABLE MEDICAL EQUIPMENT |
| DNTS | DENTAL SERVICES |
| ELEC | ELECTRICITY BILL |
| ENRG | ENERGIES |
| ESTX | ESTATE TAX |
| FERB | FERRY |
| FREX | FOREIGN EXCHANGE |
| GASB | GAS BILL |
| GDDS | PURCHASE & SALE OF GOODS |
| GDSV | PURCHASE & SALE OF GOODS AND SERVICES |
| GOVI | GOVERNMENT INSURANCE |
| GOVT | GOVERNMENT PAYMENT |
| GSCB | PURCHASE & SALE OF GOODS AND SERVICES WITH CASH-BACK |
| GVEA | AUSTRIAN GOVERNMENT EMPLOYEES CATEGORY A |
| GVEB | AUSTRIAN GOVERNMENT EMPLOYEES CATEGORY B |
| GVEC | AUSTRIAN GOVERNMENT EMPLOYEES CATEGORY C |
| GVED | AUSTRIAN GOVERNMENT EMPLOYEES CATEGORY D |
| HEDG | HEDGING |
| HLRP | HOUSING LOAN REPAYMENT |
| HLTC | HOME HEALTH CARE |
| HLTI | HEALTH INSURANCE |
| HSPC | HOSPITAL CARE |
| HSTX | HOUSING TAX |
| ICCP | IRREVOCABLE CREDIT CARD PAYMENT |
| ICRF | INTERMEDIATE CARE FACILITY |