PayoutsPayoutsPayout Beneficiaries

Retrieve Payout Beneficiary

Retrieves a single payout beneficiary by ID. Returns 404 if the beneficiary does not exist or is not owned by the caller.

Authentication

AuthorizationBearer
OAuth 2.0 access token issued by the CrissCross authorisation server.

Path parameters

payoutBeneficiaryIdstringRequiredformat: "uuid"
UUID of the payout beneficiary.

Response

Payout beneficiary retrieved successfully.
payoutBeneficiaryIdstringformat: "uuid"
UUID of the beneficiary.
merchantIdstringformat: "uuid"
Merchant ID that owns this beneficiary.
merchantReferencestring

Merchant-provided reference for de-duplication and lookup. Persisted on create and round-trips on every read.

statusenum

Lifecycle status of a payout beneficiary.

  • pending_review — created, awaiting account verification and AML pre-screening, or held for review. A name-mismatch hold (the receiving network returned a different account holder name) is cleared by the merchant via the signal endpoint (accept / reject). An AML compliance hold is cleared by CrissCross’s compliance team in our screening provider’s tooling — the merchant cannot accept / reject it.
  • approved — account verification and AML pre-screening both passed; can be referenced from payoutBeneficiaryId on a payout.
  • rejected — declined by signal, by AML pre-screening, or after exhausting verification retries. Terminal.
  • failed — verification or screening errored in a non-recoverable way. Use signal: retry to re-run the checks.
recipientobject

Recipient (payee) details. The type discriminator determines which fields are present.

verificationsobject

Outcome of the account-verification + AML pre-screening passes run against the beneficiary.

createdAtdatetime

ISO-8601 timestamp the beneficiary was created.

updatedAtdatetime

ISO-8601 timestamp of the last update.

attributesmap from strings to strings

Free-form key/value metadata attached to the beneficiary at create time.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error