Update Payee

PUT

/api/v1/merchants/{merchantId}/payees/{payeeId}

Update payee label/details/status

Request

Authorization

API Key

Add parameter in header

x-signature

Example:

x-signature: ********************

Path Params

Header Params

Body Params application/json

Examples

Update labelUpdate bank detailsDeactivate payee

{
    "label": "Primary corporate account"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Update labelUpdate bank detailsDeactivate payee

curl --location --request PUT '/api/v1/merchants//payees/' \
--header 'x-app-id;' \
--header 'x-timestamp;' \
--header 'x-nonce;' \
--header 'x-request-id;' \
--header 'x-lang;' \
--header 'x-signature: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "label": "Primary corporate account"
}'

Responses

🟢200OK

application/json

Payee updated

Bodyapplication/json

Example

{
    "success": true,
    "requestId": "req_123",
    "timestamp": "2024-01-01T00:00:00Z",
    "data": {
        "payeeId": "pay_abc123",
        "type": "BANK_ACCOUNT",
        "label": "Primary corporate account",
        "details": {
            "accountName": "ACME Inc.",
            "accountNo": "000111222333",
            "bankName": "JPMorgan"
        },
        "status": "ACTIVE",
        "createdAt": "2024-01-01T00:00:00Z"
    }
}

Modified at 2026-01-28 01:40:27

Add Payee

Delete Payee