Get beneficiary | CrissCross

{
  "beneficiaryId": "ben_f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "status": "pending",
  "currency": "NGN",
  "name": "string",
  "entityType": "business",
  "accountDetails": [
    {
      "type": "account_number",
      "value": "string"
    }
  ],
  "routingDetails": [
    {
      "rail": "fiat",
      "paymentType": "ach",
      "routingNumber": "021000021",
      "routingNumberType": "aba",
      "bank": {
        "name": "JPMorgan Chase Bank",
        "address": "270 Park Avenue, New York, NY 10017"
      }
    }
  ],
  "createdAt": "2024-01-15T09:30:00Z",
  "statusReason": "compliance_review",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postcode": "string",
    "country": "NG"
  },
  "activatedAt": "2024-01-15T09:30:00Z"
}

Retrieves a single beneficiary by ID.

Authentication

AuthorizationBearer

Token obtained via the login flow.

Path parameters

beneficiaryIdstringRequired

Response

Beneficiary details.

beneficiaryIdstring

statusenum

Poll until active before referencing in a withdrawal.

Allowed values:

currencystring

One currency per beneficiary.

namestring

Legal name.

entityTypeenum

Allowed values:

accountDetailslist of objects

routingDetailslist of objects

createdAtdatetime

statusReasonenum or nullOptional

Allowed values:

addressobjectOptional

activatedAtdatetime or nullOptional

Errors

401

Unauthorized Error

404

Not Found Error