Skip to main content
GET
/
beneficiaries
/
all
List all beneficiaries (admin)
curl --request GET \
  --url https://api.pcxpay.com/v1/beneficiaries/all
{
  "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>",
    "page": 123,
    "limit": 123
  }
}

Query Parameters

limit
integer
default:10
page
integer
default:1

Page number. Ignored when last_evaluated_key is provided.

last_evaluated_key
string

DynamoDB cursor token from a previous response. Takes precedence over page.

Response

Full beneficiary list

data
object[]
meta
object