Transfer Purpose
Tell Harbor why the funds are being sent.
Use transfer_purpose to give the reason for the transfer, such as a salary payment or support for a family member. It's required on every transfer.
Harbor needs it for compliance. Regulations require Harbor to know the reason for each transfer and to check it against anti-money-laundering rules.
Pick one of the allowed values.
Set the Transfer Purpose
Add transfer_purpose to destination when you create the transfer:
curl --location --request POST 'https://harbor-sandbox.owlpay.com/api/v2/transfers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-API-KEY: {{API_KEY}}' \
--header 'X-Idempotency-Key: {{Idempotency-Key}}' \
--data-raw '{
"quote_id": "{{QUOTE_ID}}",
"on_behalf_of": "{{CUSTOMER_UUID}}",
"application_transfer_uuid": "{{APPLICATION_TRANSFER_UUID}}",
"destination": {
...,
"transfer_purpose": "SALARY"
}
}'- A value outside the list is rejected with
422and error code2005. - The allowed values are also listed in the transfer requirements for each quote.
- To avoid sending it every time, save it in a Recipient.
Allowed Values
Personal & Household
| Enum Key | Description |
|---|---|
TRANSFER_TO_OWN_ACCOUNT | Transfers between accounts owned by the same individual |
FAMILY_MAINTENANCE | Financial support for family members |
EDUCATION | Tuition fees, school expenses, or education support |
MEDICAL_TREATMENT | Hospital fees, medical services, or healthcare costs |
HOTEL | Hotel or lodging-related payments |
TRAVEL | Travel-related expenses |
REPAYMENT_OF_LOANS | Loan principal or interest repayment |
TAX_PAYMENT | Government or statutory tax payments |
Property & Insurance
| Enum Key | Description |
|---|---|
PURCHASE_PROPERTY | Purchase of residential real estate |
PROPERTY_RENTAL | Rental payments for residential or commercial property |
INSURANCE_PREMIUM | Regular insurance premium payments |
PRODUCT_INDEMNITY_INSURANCE | Insurance covering product liability |
INSURANCE_CLAIMS | Payouts related to insurance claims |
Investment & Income
| Enum Key | Description |
|---|---|
MUTUAL_FUND_INVESTMENT | Investment into mutual funds |
INVESTMENT_SHARES | Purchase of stocks or equity instruments |
DONATIONS | Charitable or non-profit donations |
SALARY | Salary or wage payments |
Professional & Business Services
| Enum Key | Description |
|---|---|
INFO_SERVICE | Payments for data, information, or digital services |
ADVERTISING | Marketing, advertising, or PR expenses |
ROYALTY_FEES | IP-related royalty or licensing payments |
BROKER_FEES | Brokerage and custodial service fees |
ADVISOR_FEES | Professional consulting and advisory fees |
REPRESENTATIVE_EXPENSES | Costs related to representative or liaison offices |
Trade & Logistics
| Enum Key | Description |
|---|---|
CONSTRUCTION | Construction or infrastructure-related payments |
TRANSPORTATION | Logistics and freight transportation costs |
EXPORTED_GOODS | Payments related to exported goods |
DELIVERY_FEES | Last-mile or delivery service fees |
GENERAL_GOODS_OFFLINE | Offline or traditional goods trading |
Notes
- In Transfers (V1),
transfer_purposeaccepted any text. In V2, only the allowed values are accepted.
Updated about 1 month ago
Did this page help you?