Create counterparty

This API creates a new counterparty for receiving payments.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Business name of the counterparty, required when type is BUSINESS

string
enum
required

The type of counterparty

Allowed:
string
enum
required

The payment network

Allowed:
address
object
string

Email of the counterparty

counterparty_bank
object
intermediary_bank
object

The intermediary bank (conditionally required for SWIFT)

string

First name of counterparty, required when type is INDIVIDUAL

string

Last name of counterparty, required when type is INDIVIDUAL

string

Country of operation of business

string

Business activity to be specified in case type is BUSINESS, get the values from counterparty metadata API

string

Business type to be specified in case type is BUSINESS, get the values from counterparty metadata API

string

Relationship to the counterparty, get values from the counterparty metadata API

string

Occupation of the counterparty, to be specified when type is INDIVIDUAL, get values from counterparty metadata API

string

Crypto wallet address, to be specified when payment rail is CRYPTO

string

Crypto wallet chain of receiver, to be specified when payment rail is CRYPTO

string

This field is only required when payment rail is PAYIN, required for both BUSINESS and INDIVIDUAL

string

This field is only required when payment rail is PAYIN, applicable for BUSINESS

string

This field is only required when payment rail is PAYIN, applicable for BUSINESS

string

This field is only required when payment rail is PAYIN, applicable for INDIVIDUAL

Headers
string

The subaccount-id of a corporate can be passed here to make the API call on behalf of them

Response

Language
LoadingLoading…
Response
Choose an example:
application/json