Purpose Codes
This guide explains the purpose codes used when creating payments. The purpose code indicates the reason or nature of the payment transaction.
Different transaction types (B2B, B2C, C2B, C2C) support different purpose codes. Please select the appropriate code based on your transaction type and payment scenario.
Purpose Code Reference
| Code | Description | B2B | B2C | C2B | C2C | Common Scenarios |
|---|---|---|---|---|---|---|
GOODS | Payment for goods | ✅ | ✅ | ✅ | ❌ | Purchasing inventory, buying equipment, product orders |
SERVICES | Payment for services | ✅ | ✅ | ✅ | ❌ | Consulting fees, professional services, service contracts |
SAVING | Transfer of Savings (own account) | ❌ | ❌ | ❌ | ✅ | Moving funds to savings, internal account transfers |
FAMILY | Transfer for friends/family | ❌ | ❌ | ❌ | ✅ | Sending money to family, gifts to friends, personal support |
INTER_GROUP_TRANSFER | Repatriation of funds/inter-company transfer | ✅ | ❌ | ❌ | ❌ | Inter-company transfers, group fund movements, repatriation of profits |
HIGH_VALUE_ITEM | Payment for high value items (property, jewelleries, vehicle, etc) | ✅ | ✅ | ✅ | ✅ | Property purchases, jewelry transactions, vehicle purchases, luxury goods |
INVESTMENT | Investment | ✅ | ✅ | ✅ | ❌ | Investment deposits, portfolio funding, capital investments |
DEBT | Debt/Debt Repayment | ✅ | ✅ | ✅ | ✅ | Loan repayments, debt settlements, credit payments |
COMPANY_MANAGE | Company Management Expenses (Salary, Rental, Utility Bills, etc) | ✅ | ✅ | ❌ | ❌ | Salary payments, rent payments, utility bills, office expenses |
FREIGHT | Payment for logistic/freight | ✅ | ✅ | ✅ | ❌ | Shipping fees, freight charges, logistics services, transportation costs |
Transaction Types
- B2B: Business to Business
- B2C: Business to Consumer
- C2B: Consumer to Business
- C2C: Consumer to Consumer
Usage in API
When creating a payment, include the purposeCode field in your request:
{
"clientId": "401f4647-8372-495f-8de0-aafb3e1eaf93",
"beneficiaryId": "501f4647-8372-495f-8de0-aafb3e1eaf93",
"currencyCode": "USD",
"amount": 10000,
"purposeCode": "GOODS",
"paymentReference": "Invoice #123",
"paymentDate": "2024-07-30"
}
Best Practices
Important Notes
- Select Appropriate Code: Choose the purpose code that matches both your transaction type (B2B/B2C/C2B/C2C) and the nature of payment
- Compliance: Proper purpose codes help with regulatory compliance and reporting
- Required Field: The purpose code is a required field when creating payments