Create Payid beneficiary

Developing

POST

/customers/v1/beneficiaries/payid

The payid beneficiary creation endpoint. You must provide either person OR company details, but not both.

Request

Header Params

Body Params application/jsonRequired

Examples

with person detailswith company details

{
    "person": {
        "name": "NPP Payid beneficiary-staging"
    },
    "pay_id": "payid@example.com",
    "pay_id_type": "EMAIL",
    "pay_id_name": "Test Payid staging",
    "metadata": {}
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

with person detailswith company details

curl --location --request POST '/customers/v1/beneficiaries/payid' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "person": {
        "name": "NPP Payid beneficiary-staging"
    },
    "pay_id": "payid@example.com",
    "pay_id_type": "EMAIL",
    "pay_id_name": "Test Payid staging",
    "metadata": {}
}'

Responses

🟢201Created

application/json

Body

Example

{
    "id": "364e5de7-411f-42cc-a90d-0833caa5ab43",
    "account_number": null,
    "bank_code": null,
    "bank_code_type": null,
    "bank_country": null,
    "bank_name": null,
    "pay_id": "payid@example.com",
    "pay_id_type": "EMAIL",
    "pay_id_name": "Test Payid staging",
    "pay_id_status": "ENABLED",
    "pay_id_registered_at": "2026-01-21T05:57:50.263Z",
    "created_at": "2026-01-21T05:57:50.265Z",
    "updated_at": "2026-01-21T05:57:50.265Z",
    "status": "ACTIVE",
    "person": {
        "name": "NPP Payid beneficiary-staging"
    },
    "company": null,
    "metadata": {}
}

Modified at 2026-01-21 06:40:24

Update beneficiary

Cards API