POST
/
buyers

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

A request to create a buyer.

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.

Required string length: 1 - 200
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.

Required string length: 1 - 200
billing_details
object

The optional billing details to associate with a buyer.

Response

201 - application/json
type
enum<string>

The type of this resource. Is always buyer.

Available options:
buyer
id
string

The unique Gr4vy ID for this buyer.

billing_details
object

The billing details associated with a buyer.

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.

Required string length: 1 - 200
external_identifier
string | null

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

Required string length: 1 - 200
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.

Was this page helpful?

List buyersGet buyer