1. Payees
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. Payees

Update Payee State (Admin)

PUT
/api/v1/admin/payees/{id}/state
Last modified:2026-07-16 12:48:45
Admin endpoint to change a payee's state (e.g. approve or reject).
Fields
FieldTypeDescriptionConstraints
statusstringNew payee status (e.g. approved, rejected)Max: 100
rejectReasonstringReason when rejectingNullable
metadatastringFree-form metadataNullable

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Payee state updated.
Bodyapplication/json

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/api/v1/admin/payees/9b2f1c44-8a31-4f0d-9d6e-1c2b3a4d5e6f/state' \
--header 'Content-Type: application/json' \
--data '{
    "status": "approved",
    "rejectReason": null,
    "metadata": null
}'
Response Response Example
{
    "success": true,
    "status": "approved"
}
Modified at 2026-07-16 12:48:45
Previous
Update Fiat Payee
Next
Get Merchant Crypto Payout Config
Built with