API Reference

Create Beneficiary

post
https://api.coingate.com/api/v2/beneficiaries
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Register a beneficiary (person or business) to receive payouts from your CoinGate account. Depending on the beneficiary_type, different personal or business details are required.

Form Data
string
enum
required

Beneficiary type decides if first name surname email and date of birth or company_name and company code fields will be required

Allowed:
person
object

Required only if beneficiary_type is "person"

business
object

Required only if beneficiary_type is "business"

string
required
string
required

Country alpha3 code

string

Required when the country includes states. Use the state's alpha-2 code.

int32
required

Retrieve the currency_id by making a request to the following API endpoint: https://developer.coingate.com/reference/currencies. The values for currency_id and platform_id differ between the live and sandbox environments. Make sure to retrieve these values according to your integration environment from either api.coingate.com for production or api-sandbox.coingate.com for sandbox testing.

int32
required

Retrieve the platform_id and supported currencies by making a request to the following API endpoint: https://developer.coingate.com/reference/platforms. The values for currency_id and platform_id differ between the live and sandbox environments. Make sure to retrieve these values according to your integration environment from either api.coingate.com for production or api-sandbox.coingate.com for sandbox testing.

string
required

Crypto address

string

Required destination_tag for XRP, memo for BNB,XLM,SOLANA ex. 12345

string

Street name

string

Building number

string

Town name

string

Postcode

string

(YYYY-MM-DD or MM/DD/YYYY) Date of birth

Responses

Updated 26 days ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 26 days ago