Skip to main content
POST
Beneficiaries create

Authorizations

ApiKey
string
header
required

The service account's API key.

Nonce
string
header
required

A GUID, single-use. A replayed nonce is rejected.

Signature
string
header
required

Base64 RSA/SHA-256 (PKCS#1 v1.5) signature over the canonical string: METHOD, path, canonical query, Timestamp, Nonce, API secret and the lowercase hex SHA-256 of the raw body, joined with LF. Sign the PUBLIC path exactly as called (e.g. /v1/webhooks), not any internal path.

Timestamp
string
header
required

Unix seconds. Rejected outside the server's tolerance window.

Body

application/json
beneficiaryName
string
required
isAccountOwner
boolean
required
account
string | null
accountType
enum<string> | null
Available options:
Iban,
WalletAddress
accountVerificationId
string<uuid> | null
alias
string | null
countryCode
string | null
rail
enum<string> | null
Available options:
Sepa,
Swift,
Wallet
railDetails
object | null
type
enum<string> | null
Available options:
Business,
Personal

Response

Created

account
string
required
accountMasked
string
required
createdAt
string<date-time>
required
id
string<uuid>
required
isAccountOwner
boolean
required
rail
enum<string>
required
Available options:
Sepa,
Swift,
Wallet
railDetails
object
required
accountType
enum<string> | null
Available options:
Iban,
WalletAddress
alias
string | null
type
enum<string> | null
Available options:
Business,
Personal