Skip to main content
GET
/
beneficiaries
List beneficiaries for the current user
curl --request GET \
  --url https://api.pcxpay.com/v1/beneficiaries
{
  "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>"
  }
}

Headers

X-User-Id
string

ID of the authenticated user making the request. Used for ownership checks and to populate beneficiary_of on creation.

Query Parameters

user_id
string

Fallback user identifier if X-User-Id header is not present.

limit
integer
default:10
last_evaluated_key
string

DynamoDB pagination token from a previous response.

Response

Beneficiary list

data
object[]
meta
object