STstriga
Reporting

List recipients

Lists the payout recipients registered for your application, newest first.

By default DEACTIVATED recipients are excluded — pass status explicitly to see them. Use a recipient's id as the beneficiaryId on a payout.

Recipients appear as PENDING until sanctions screening completes, then flip to ACTIVE. Only ACTIVE recipients can be paid.

post/beneficiaries/list

Request

  • Base URL
    https://www.sandbox.striga.com/api/v1/grid
  • URL
    https://www.sandbox.striga.com/api/v1/grid/beneficiaries/list
  • Auth
    API key in header api-key and API key in header Authorization

Request body

status'PENDING' | 'ACTIVE' | 'DEACTIVATED' | 'BLACKLISTED'

Lifecycle state of a recipient. PENDING means sanctions screening has not finished yet; only ACTIVE recipients can be paid.

limitinteger

Page size, 1-100.

offsetinteger

Number of records to skip.

Example request

{
  "limit": 25
}

Response

A page of recipients.

totalinteger

Total matching the filter, across all pages.

limitinteger
offsetinteger

Example response

{
  "beneficiaries": [
    {
      "id": "9c9c8d5f-1204-4a30-ae40-aa951f0ae5b3",
      "currency": "USDC",
      "accountDetails": {
        "accountType": "MXN_ACCOUNT",
        "accountNumber": "12345678",
        "routingNumber": "123456789",
        "bankName": "Chase",
        "clabeNumber": "002010077777777771",
        "pixKey": "user@example.com",
        "taxId": "52998224725",
        "paymentRails": [
          "SPEI"
        ]
      },
      "beneficiaryInfo": {
        "beneficiaryType": "BUSINESS",
        "fullName": "Maria Silva",
        "legalName": "Empresa S.A. de C.V.",
        "countryOfResidence": "MX"
      },
      "linkedAccountId": "d6dbd90b64ef20fe6bafa9984a0c849b"
    }
  ],
  "total": 1,
  "limit": 25
}

Changes

No recorded changes to this operation across all 1 revision of this API.