List Payout Beneficiaries

curl -G https://api.crisscross.money/v1/payout-beneficiaries \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     --data-urlencode merchantIds=a3f1c9d2-4b7e-4f8a-9c3d-2e5f7a1b8c9d,b2d4e6f8-1a3c-4e5f-9b7d-0c2a4e6f8b9d \
     -d status=approved

{
  "payoutBeneficiaries": [
    {
      "payoutBeneficiaryId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "merchantId": "a3f1c9d2-4b7e-4f8a-9c3d-2e5f7a1b8c9d",
      "merchantReference": "INV-20240315-001",
      "status": "pending_review",
      "recipient": {
        "type": "bank_account",
        "accountHolderName": "Jane Doe",
        "accountNumber": "1234567890",
        "bankCode": "044",
        "country": "NGA",
        "phoneNumber": "+2348012345678"
      },
      "verifications": {
        "accountVerification": {
          "state": "PENDING",
          "attempts": 1,
          "provider": "NIBSS",
          "returnedAccountHolderName": "Jane D.",
          "lastError": "Name mismatch detected"
        },
        "amlScreening": {
          "state": "UNSPECIFIED",
          "attempts": 1,
          "reviewReason": ""
        }
      },
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "attributes": {
        "customerTier": "gold",
        "notes": "Priority beneficiary"
      }
    }
  ]
}

Lists payout beneficiaries across one or more merchants the caller has access to, optionally filtered by status.

Authentication

AuthorizationBearer

OAuth 2.0 access token issued by the CrissCross authorisation server.

Query parameters

merchantIdslist of stringsRequired

Comma-separated list of merchant IDs to list beneficiaries for. The caller must have access to every merchant in this list.

statusenumOptional

Filter by beneficiary status.

Allowed values:

Response

Payout beneficiaries retrieved successfully.

payoutBeneficiarieslist of objects

Page of payout beneficiaries across the requested merchants.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error