Skip to main content
GET
/
beneficiaries
List beneficiaries for the current user
curl --request GET \
  --url https://prod-api.pcxpay.com/v1/beneficiaries \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'
{
  "data": [
    {
      "beneficiary_id": "<string>",
      "account_type": "bank",
      "beneficiary_of": "<string>",
      "beneficiary_type": "loan_client",
      "country": "<string>",
      "currency": "<string>",
      "fname": "<string>",
      "lname": "<string>",
      "email": "<string>",
      "phone_number": "<string>",
      "momo_details": {},
      "bank_details": {},
      "loan_client_details": {},
      "external_account_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "meta": {
    "count": 123,
    "last_evaluated_key": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.pcxpay.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

​
X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Query Parameters

​
user_id
string

Optionally scope the list to a specific user ID.

​
limit
integer
default:10
​
last_evaluated_key
string

DynamoDB pagination token from a previous response.

Response

Beneficiary list

​
data
object[]
​
meta
object