This endpoint requires the buyers.write scope.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
A request to create a buyer.
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
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
The optional billing details to associate with a buyer.
billing_details.first_name
The first name(s) or given name for the buyer.
Required string length: 1 - 255
billing_details.last_name
The last name, or family name, of the buyer.
Required string length: 1 - 255
billing_details.email_address
The email address for the buyer.
Required string length: 1 - 320
billing_details.phone_number
Required string length: 1 - 50
The billing address for the buyer.
billing_details.address.city
The city for the address.
Required string length: 1 - 100
billing_details.address.country
The country for the address in ISO 3166 format.
Required string length: 2
billing_details.address.postal_code
The postal code or zip code for the address.
Required string length: 1 - 50
billing_details.address.state
The state, county, or province for the address.
Required string length: 1 - 255
billing_details.address.line1
The first line of the address.
Required string length: 1 - 255
billing_details.address.state_code
The code of state, county, or province for the address in
ISO 3166-2 format.
Required string length: 4 - 6
billing_details.address.house_number_or_name
The house number or name for the address. Not all payment
services use this field but some do.
Required string length: 1 - 255
billing_details.address.line2
The second line of the address.
Required string length: 1 - 255
billing_details.address.organization
The optional name of the company or organisation to add
to the address.
Required string length: 1 - 255
The tax ID information associated with the billing details.
billing_details.tax_id.value
The tax ID for the buyer.
Required string length: 1 - 50
billing_details.tax_id.kind
Available options:
ae.trn,
au.abn,
ar.dni,
ar.cuil,
ar.cuit,
br.cnpj,
br.cpf,
ca.bn,
ca.gst_hst,
ca.pst_bc,
ca.pst_mb,
ca.pst_sk,
ca.qst,
ch.vat,
cl.tin,
es.cif,
eu.vat,
gb.vat,
hk.br,
id.nik,
id.npwp,
in.gst,
jp.cn,
jp.rn,
kr.brn,
li.uid,
mx.curp,
my.frp,
my.itn,
my.nric,
my.sst,
no.vat,
nz.gst,
ph.tin,
ru.inn,
ru.kpp,
sa.vat,
sg.gst,
sg.uen,
th.id,
th.vat,
tw.vat,
us.ein,
za.vat
The type of this resource. Is always buyer.
The unique Gr4vy ID for this buyer.
The billing details associated with a buyer.
The type of this resource. Is always billing-details.
Available options:
billing-details
billing_details.first_name
The first name(s) or given name of the buyer.
Required string length: 1 - 255
billing_details.last_name
The last name, or family name, of the buyer.
Required string length: 1 - 255
billing_details.email_address
The email address of the buyer.
Required string length: 1 - 320
billing_details.phone_number
Required string length: 1 - 50
The billing address of the buyer.
billing_details.address.city
The city for the address.
Required string length: 1 - 100
billing_details.address.country
The country for the address in ISO 3166 format.
Required string length: 2
billing_details.address.postal_code
The postal code or zip code for the address.
Required string length: 1 - 50
billing_details.address.state
The state, county, or province for the address.
Required string length: 1 - 255
billing_details.address.state_code
The code of state, county, or province for the address in
ISO 3166-2 format.
Required string length: 4 - 6
billing_details.address.house_number_or_name
The house number or name for the address. Not all payment
services use this field but some do.
Required string length: 1 - 255
billing_details.address.line1
The first line of the address.
Required string length: 1 - 255
billing_details.address.line2
The second line of the address.
Required string length: 1 - 255
billing_details.address.organization
The optional name of the company or organisation to add
to the address.
Required string length: 1 - 255
The tax information associated with the billing details.
billing_details.tax_id.value
The tax ID for the buyer.
Required string length: 1 - 50
billing_details.tax_id.kind
Available options:
ae.trn,
au.abn,
ar.dni,
ar.cuil,
ar.cuit,
br.cnpj,
br.cpf,
ca.bn,
ca.gst_hst,
ca.pst_bc,
ca.pst_mb,
ca.pst_sk,
ca.qst,
ch.vat,
cl.tin,
es.cif,
eu.vat,
gb.vat,
hk.br,
id.nik,
id.npwp,
in.gst,
jp.cn,
jp.rn,
kr.brn,
li.uid,
mx.curp,
my.frp,
my.itn,
my.nric,
my.sst,
no.vat,
nz.gst,
ph.tin,
ru.inn,
ru.kpp,
sa.vat,
sg.gst,
sg.uen,
th.id,
th.vat,
tw.vat,
us.ein,
za.vat
The date and time
when this buyer was created in our system.
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
An external identifier that can be used to match the buyer against your own records.
Required string length: 1 - 200
The unique ID for a merchant account.
The date and time
when this buyer was last updated in our system.
