Skip to main content
POST
Simulate a USD beneficiary outcome (sandbox only)

Authorizations

Authorization
string
header
required

Your Jenzy API key: Authorization: Bearer jz_live_…

Headers

HERMES-ORG
string<uuid>

The id of one of your Child orgs. The call then acts on that Child org, not on your organization. If you do not send it, the call acts on your organization. An id that is not one of your Child orgs gives 404.

Example:

"3f1c2a9e-8b7d-4e21-9a6f-0c5d4b3e2a10"

Path Parameters

id
string
required

The beneficiary id (UUID).

Body

application/json
outcome
enum<string>
required

What the beneficiary becomes: rejected from pending, inactive from active, active from pending or inactive.

Available options:
active,
inactive,
rejected
Example:

"rejected"

Response

The USD beneficiary, with its new status.

id
string<uuid>
required

Name it in a USD payout’s destination.beneficiary_id.

asset
string
required

USD: beneficiaries are for USD payouts only.

Minimum string length: 1
Example:

"USD"

status
enum<string>
required

pending: being checked, not payable yet. active: payable. rejected: final; these bank details cannot be registered again. inactive: not payable now; it may become active again.

Available options:
pending,
active,
rejected,
inactive
holder
object
required
holder_address
object
required
bank
object
required
rail
string
required
Example:

"fedwire"

routing_number
string
required
intermediary_routing_number
string | null
required
counter_party
string
required
Example:

"third_party"

relationship
string
required
Example:

"supplier"

purpose
string
required
Example:

"freight"

failure
object | null
required

Set only when status is rejected: recipient_account_invalid (the bank details were refused) or declined.

created_at
string<date-time>
required
updated_at
string<date-time>
required