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 422 and error code 2005.
  • 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 KeyDescription
TRANSFER_TO_OWN_ACCOUNTTransfers between accounts owned by the same individual
FAMILY_MAINTENANCEFinancial support for family members
EDUCATIONTuition fees, school expenses, or education support
MEDICAL_TREATMENTHospital fees, medical services, or healthcare costs
HOTELHotel or lodging-related payments
TRAVELTravel-related expenses
REPAYMENT_OF_LOANSLoan principal or interest repayment
TAX_PAYMENTGovernment or statutory tax payments

Property & Insurance

Enum KeyDescription
PURCHASE_PROPERTYPurchase of residential real estate
PROPERTY_RENTALRental payments for residential or commercial property
INSURANCE_PREMIUMRegular insurance premium payments
PRODUCT_INDEMNITY_INSURANCEInsurance covering product liability
INSURANCE_CLAIMSPayouts related to insurance claims

Investment & Income

Enum KeyDescription
MUTUAL_FUND_INVESTMENTInvestment into mutual funds
INVESTMENT_SHARESPurchase of stocks or equity instruments
DONATIONSCharitable or non-profit donations
SALARYSalary or wage payments

Professional & Business Services

Enum KeyDescription
INFO_SERVICEPayments for data, information, or digital services
ADVERTISINGMarketing, advertising, or PR expenses
ROYALTY_FEESIP-related royalty or licensing payments
BROKER_FEESBrokerage and custodial service fees
ADVISOR_FEESProfessional consulting and advisory fees
REPRESENTATIVE_EXPENSESCosts related to representative or liaison offices

Trade & Logistics

Enum KeyDescription
CONSTRUCTIONConstruction or infrastructure-related payments
TRANSPORTATIONLogistics and freight transportation costs
EXPORTED_GOODSPayments related to exported goods
DELIVERY_FEESLast-mile or delivery service fees
GENERAL_GOODS_OFFLINEOffline or traditional goods trading


Notes

  • In Transfers (V1), transfer_purpose accepted any text. In V2, only the allowed values are accepted.

Did this page help you?