1. Payout Screen
Artha Payments API
  • Introduction
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Update Customer
      PATCH
  • Manage Account
    • Get Payout Currencies
      GET
    • Save Payout Currency
      POST
    • Update Payout Currency State
      PUT
  • Payees
    • Get Fiat Payees List (Grid)
      GET
    • View Fiat Payee Details
      GET
    • Get Recipient Form Fields
      GET
    • Get Payees Lookup Data
      GET
    • Get Phone Codes Lookup
      GET
    • Get Countries With States Lookup
      GET
    • Get Payee Countries
      GET
    • Get Currencies With Countries
      GET
    • Create Fiat Payee
      POST
    • Update Fiat Payee
      PUT
    • Update Payee State (Admin)
      PUT
  • Payout Screen
    • Get Merchant Crypto Payout Config
      GET
    • Get Active Fiat Payout Currencies
      GET
    • Get Fiat Payees
      GET
    • Get Payment Purposes
      GET
    • Get Source Of Funds
      GET
    • Payments Lookup (Core)
      GET
    • Get Transfer Types
      GET
    • Get Crypto Payout Fee
      POST
    • Create Crypto Payout
      POST
    • Payments Order Creation (Provider)
      POST
    • Get Crypto Payout Transactions
      GET
  1. Payout Screen

Get Payment Purposes

GET
/api/v1/purpose
Last modified:2026-07-16 11:55:25
Returns the master list of payment purposes (grouped) used when creating a payout.

Request

Header Params

Responses

🟢200
application/json
Payment purposes grouped by category.
Bodyapplication/json

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/purpose' \
--header 'authinformation;'
Response Response Example
{
    "purposes": [
        {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "Family Support",
            "code": "FAM",
            "isMandatory": true
        }
    ]
}
Modified at 2026-07-16 11:55:25
Previous
Get Fiat Payees
Next
Get Source Of Funds
Built with