This endpoint requires the buyers.read scope. The buyers.billing-details.read scope is needed to see all personally identifiable information.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Please do not use this query parameter in a production application, as this API call is
very inefficient and may negatively impact transaction performance.
Filters the results to only the buyers for which the display_name, email_address
or external_identifier matches this value. This field allows for a case insensitive
partial match, matching any buyer for which any of the fields partially or
completely matches.
Filters the results to only the items for which the buyer has an
external_identifier that exactly matches this value.
Defines the maximum number of items to return for this request.
Required range: 1 < x < 100
A cursor that identifies the page of results to return. This is used to
paginate the results of this API.
For the first page of results, this parameter can be left out.
For additional pages, use the value returned by the API in
the next_cursor field. Similarly the previous_cursor can be used to
reverse backwards in the list.
The type of this resource. Is always buyer.
The unique Gr4vy ID for this buyer.
The billing details associated with a buyer.
items.billing_details. type
The type of this resource. Is always billing-details.
Available options:
billing-details
items.billing_details. first_name
The first name(s) or given name of the buyer.
Required string length: 1 - 255
items.billing_details. last_name
The last name, or family name, of the buyer.
Required string length: 1 - 255
items.billing_details. email_address
The email address of the buyer.
Required string length: 1 - 320
items.billing_details. phone_number
Required string length: 1 - 50
items.billing_details. address
The billing address of the buyer.
items.billing_details.address. city
The city for the address.
Required string length: 1 - 100
items.billing_details.address. country
The country for the address in ISO 3166 format.
Required string length: 2
items.billing_details.address. postal_code
The postal code or zip code for the address.
Required string length: 1 - 50
items.billing_details.address. state
The state, county, or province for the address.
Required string length: 1 - 255
items.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
items.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
items.billing_details.address. line1
The first line of the address.
Required string length: 1 - 255
items.billing_details.address. line2
The second line of the address.
Required string length: 1 - 255
items.billing_details.address. organization
The optional name of the company or organisation to add
to the address.
Required string length: 1 - 255
items.billing_details. tax_id
The tax information associated with the billing details.
items.billing_details.tax_id. value
The tax ID for the buyer.
Required string length: 1 - 50
items.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
items. external_identifier
An external identifier that can be used to match the buyer against your own records.
Required string length: 1 - 200
items. merchant_account_id
The unique ID for a merchant account.
The date and time
when this buyer was last updated in our system.
The limit applied to request. This represents the number of items that are at
maximum returned by this request.
Required range: 1 < x < 100
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
Required string length: 1 - 1000
The cursor that represents the next page of results. Use the cursor query
parameter to fetch this page of items.
Required string length: 1 - 1000
