Create beneficiary

post

https://api.sandbox.toq.io/wallet/api/customers/{customerId}/clients/{clientId}/beneficiaries

Creates a new beneficiary for the given client. The beneficiary can be either external (identified by account details such as IBAN/account number plus bank details) or internal (linked to another Toqio account). Once created the beneficiary can be used as the destination of a payment via the Create Transaction endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientId

string

required

clientId

customerId

string

required

customerId

Body Params

Beneficiary details to create

companyId

string

The id of the client

type

string

enum

Allowed:

addressCity

string

length ≤ 100

addressIsoCountry

string

required

length ≤ 100

addressPostalCode

string

length ≤ 100

addressStreet

string

length ≤ 1000

assetType

string

enum

The asset of the beneficiary

bank

string

Name of the beneficiary bank

bankCountry

string

required

Country of the beneficiary bank

bicSwift

string

accountNumber

string

For US, Australian and Canadian accounts

bsbCode

string

Just for Australian accounts

caRoutingNumber

string

Just for Canadian accounts

iban

string

routingNumber

string

Just for US accounts

clabe

string

Mexican CLABE (18 digits). Required for Mexican accounts (bankCountry MX)

ifsc

string

Indian IFSC code. Required for Indian accounts (bankCountry IN)

cnaps

string

Chinese CNAPS code. For Chinese accounts (bankCountry CN)

ukAccountNumber

string

^(\d){7,8}$

Just for UK accounts

ukSortCode

string

^[0-9]{6}$

Just for UK accounts

firstName

string

length ≤ 100

^[ÑA-Zña-z0-9.\s-]+$

required if type is PERSON

lastName

string

length ≤ 100

^[ÑA-Zña-z0-9.\s-]+$

required if type is PERSON

name

string

length ≤ 60

required if type is COMPANY

visible

boolean

Defaults to true

allows a user to display or not a beneficiary. True by default

Responses

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200OK