Skip to main content
GET
/
api
/
v1
/
purposecategories
/
{direction}
Get Purpose Categories
curl --request GET \
  --url https://www.{baseurl}.com/api/v1/purposecategories/{direction} \
  --header 'x-client-id: <x-client-id>'
[
  {
    "purposeCategory": {
      "name": "Business",
      "value": 1,
      "description": "Business-related payments"
    },
    "purposeCodes": [
      {
        "name": "Dues And Fees",
        "value": 450,
        "description": "Membership dues and fees"
      },
      {
        "name": "Loan Payment",
        "value": 460,
        "description": "Loan or mortgage payment"
      }
    ]
  }
]
Work in progressThis section is currently under active development as part of improvements planned for 2026. Content may change as we expand product capabilities.If you’re interested in early access or want to learn more about what’s coming, feel free to reach out to the team.
Retrieve the available payment purpose categories and codes for a given payment direction. Use the value from the returned purpose codes as the transactionCode when creating a transaction.

​
Direction Values

  • Debit — Purpose categories for collecting payments from customers
  • Credit — Purpose categories for sending payments to customers

Headers

​
x-client-id
string
required

Your API key provided during onboarding.

Path Parameters

​
direction
enum<string>
required

Payment direction: Debit or Credit.

Available options:
Debit,
Credit

Response

Purpose categories retrieved successfully

​
purposeCategory
object
​
purposeCodes
object[]