Get transfer purpose codes

GET /orders/purposes
Bearer auth

Retrieve available purpose codes for international transfers

Headers

  • Workspace-ID integer Required

    The workspace ID - to identify the sub-user

Responses

  • 200 application/json

    Map of purpose codes to descriptions

    Hide response attributes Show response attributes object
    • IR001 string

      Transfer to Own Account

    • IR002 string

      Family maintenance

    • IR003 string

      Education Expenses
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • errorCode string Required

      Error code

    • message string Required

      Error message
GET /orders/purposes 
curl \
 --request GET 'https://auth.bank.place/orders/purposes' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Workspace-ID: 42"
Response examples (200) 
{
  "IR001": "Transfer to Own Account",
  "IR002": "Family maintenance",
  "IR003": "Education Expenses",
  "IR004": "Medical Treatment",
  "IR007": "Utility Bills",
  "IR008": "Loan Repayment",
  "IR009": "Tax Payment",
  "IR010": "Residential Property Purchase",
  "IR011": "Property Rental Payment",
  "IR012": "Insurance",
  "IR016": "Investment (Shares)"
}
Response examples (401) 
{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}