New buyer

This endpoint requires the buyers.write scope.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

external_identifier

string | null

An external identifier that can be used to match the buyer against your own records. This value needs to be unique for all buyers.

display_name

string | null

A unique name for this buyer which is used in the Gr4vy admin panel to give a buyer a human readable name.

billing_details

object

The optional billing details to associate with a buyer.

billing_details.first_name

string | null

The first name(s) or given name for the buyer.

billing_details.last_name

string | null

The last name, or family name, of the buyer.

billing_details.email_address

string | null

The email address for the buyer.

billing_details.phone_number

string | null

The phone number for the buyer which should be formatted according to the E164 number standard.

billing_details.address

object

The billing address for the buyer.

billing_details.tax_id

object

The tax ID information associated with the billing details.

Response

201 - application/json

type

enum<string>

The type of this resource. Is always buyer.

Available options:

buyer

string

The unique Gr4vy ID for this buyer.

billing_details

object

The billing details associated with a buyer.

billing_details.type

enum<string>

The type of this resource. Is always billing-details.

Available options:

billing-details

billing_details.first_name

string | null

The first name(s) or given name of the buyer.

billing_details.last_name

string | null

The last name, or family name, of the buyer.

billing_details.email_address

string | null

The email address of the buyer.

billing_details.phone_number

string | null

The phone number of the buyer. This number is formatted according to the E164 number standard.

billing_details.address

object

The billing address of the buyer.

billing_details.tax_id

object

The tax information associated with the billing details.

created_at

string

The date and time when this buyer was created in our system.

display_name

string | null

A unique name for this buyer which is used in the Gr4vy admin panel to give a buyer a human readable name.

external_identifier

string | null

An external identifier that can be used to match the buyer against your own records.

merchant_account_id

string

The unique ID for a merchant account.

updated_at

string

The date and time when this buyer was last updated in our system.

Payments

Instruments

Vault

Connections

Dashboard

Errors

Authorizations

Body

Response