Skip to main content
POST
Register a USD beneficiary

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"

Body

application/json
holder
object
required
holder_address
object
required
bank
object
required
rail
enum<string>
required

How the USD is sent: fedwire (US banks) or swift.

Available options:
fedwire,
swift
routing_number
string
required

fedwire: the 9-digit ABA routing number. swift: the bank’s BIC.

Example:

"121145349"

counter_party
enum<string>
required

first_party: an account of your own organization. third_party: anyone else.

Available options:
first_party,
third_party
relationship
enum<string>
required

What the holder is to your organization.

Available options:
supplier,
vendor,
service_provider,
merchant,
contractor,
customer,
subsidiary,
parent_company,
affiliate_business,
bank_account,
employee,
freelancer,
gig_worker,
affiliate,
family_member,
friend,
self
purpose
enum<string>
required

Why your organization pays this holder. A business holder takes goods, services, freight or intercompany. An individual holder takes family_support, goods, services, income, education, donation, investment or own_account.

Available options:
goods,
services,
freight,
intercompany,
family_support,
income,
education,
donation,
investment,
own_account
intermediary_routing_number
string

Required for swift, refused for fedwire: the intermediary bank’s ABA routing number or BIC.

Response

These bank details are already registered with this body: the existing one.

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