Skip to main content
GET
/
beneficiaries
/
loan-clients
/
{org_id}
List beneficiaries by organisation
curl --request GET \
  --url https://prod-api.pcxpay.com/v1/beneficiaries/loan-clients/{org_id} \
  --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>"
    }
  ],
  "pagination": {}
}

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"

Path Parameters

​
org_id
string
required

Query Parameters

​
type
enum<string>

Filter by beneficiary_type (e.g. loan_client, payout_recipient).

Available options:
loan_client,
payout_recipient
​
query
string

Free-text search string applied by the use-case layer.

​
limit
integer
default:10
​
next_token
string

JSON-encoded DynamoDB pagination token from a previous response.

Response

Organisation beneficiary list

​
data
object[]
​
pagination
object

DynamoDB pagination info returned by the use-case layer.