List all buyers

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

ListBuyersRequest req = new ListBuyersRequest() {};

ListBuyersResponse? res = await sdk.Buyers.ListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

{
  "items": [
    {
      "merchant_account_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "type": "buyer",
      "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
      "display_name": "John Doe",
      "external_identifier": "buyer-12345",
      "billing_details": {
        "first_name": "John",
        "last_name": "Doe",
        "email_address": "[email protected]",
        "phone_number": "+1234567890",
        "address": {
          "city": "San Jose",
          "country": "US",
          "postal_code": "94560",
          "state": "California",
          "state_code": "US-CA",
          "house_number_or_name": "10",
          "line1": "Stafford Appartments",
          "line2": "29th Street",
          "organization": "Gr4vy"
        },
        "tax_id": {
          "value": "<string>",
          "kind": "ae.trn"
        }
      },
      "account_number": "<string>"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

GET

buyers

using Gr4vy;
using Gr4vy.Models.Components;
using Gr4vy.Models.Requests;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

ListBuyersRequest req = new ListBuyersRequest() {};

ListBuyersResponse? res = await sdk.Buyers.ListAsync(req);

while(res != null)
{
    // handle items

    res = await res.Next!();
}

{
  "items": [
    {
      "merchant_account_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "type": "buyer",
      "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
      "display_name": "John Doe",
      "external_identifier": "buyer-12345",
      "billing_details": {
        "first_name": "John",
        "last_name": "Doe",
        "email_address": "[email protected]",
        "phone_number": "+1234567890",
        "address": {
          "city": "San Jose",
          "country": "US",
          "postal_code": "94560",
          "state": "California",
          "state_code": "US-CA",
          "house_number_or_name": "10",
          "line1": "Stafford Appartments",
          "line2": "29th Street",
          "organization": "Gr4vy"
        },
        "tax_id": {
          "value": "<string>",
          "kind": "ae.trn"
        }
      },
      "account_number": "<string>"
    }
  ],
  "limit": 20,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": "Xkjss7asS"
}

This endpoint requires the buyers.read scope. The buyers.billing-details.read scope is needed to see all personally identifiable information.

Authorizations

Authorization

string

header

required

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

Headers

x-gr4vy-merchant-account-id

string

The ID of the merchant account to use for this request. The ID of the merchant account to use for this request.

Query Parameters

cursor

string | null

A pointer to the page of results to return. A pointer to the page of results to return.

Example:

"ZXhhbXBsZTE"

limit

integer

default:20

The maximum number of items that are at returned. The maximum number of items that are at returned.

Required range: 1 <= x <= 100

string | null

Filters the results to only the buyers for which the display_name or external_identifier matches this value. Filters the results to only the buyers for which the display_name or external_identifier matches this value.

Example:

"John"

external_identifier

string | null

Filters the results to only the buyers for which the external_identifier matches this value. Filters the results to only the buyers for which the external_identifier matches this value.

Example:

"buyer-12345"

Response

Successful Response

items

Buyer · object[]

required

A list of items returned for this request.

Show child attributes

items.merchant_account_id

string

required

The ID of the merchant account this buyer belongs to.

items.created_at

string<date-time>

required

The date this buyer was created at.

items.updated_at

string<date-time>

required

The date this buyer was last updated at.

items.type

string

default:buyer

Always buyer.

Allowed value: "buyer"

items.id

string<uuid> | null

The ID for the buyer.

Example:

"fe26475d-ec3e-4884-9553-f7356683f7f9"

items.display_name

string | null

The display name for the buyer.

Required string length: 1 - 200

Example:

"John Doe"

items.external_identifier

string | null

The merchant identifier for this buyer.

Required string length: 1 - 200

Example:

"buyer-12345"

items.billing_details

BillingDetails · object

The billing name, address, email, and other fields for this buyer.

Show child attributes

items.billing_details.first_name

string | null

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

Required string length: 1 - 255

Example:

"John"

items.billing_details.last_name

string | null

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

Required string length: 1 - 255

Example:

"Doe"

items.billing_details.email_address

string | null

The email address for the buyer.

Required string length: 1 - 320

Example:

"[email protected]"

items.billing_details.phone_number

string | null

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

Example:

"+1234567890"

items.billing_details.address

Address · object

The billing address for the buyer.

Show child attributes

items.billing_details.address.city

string | null

The city for the address.

Required string length: 1 - 100

Example:

"San Jose"

items.billing_details.address.country

string | null

The country for the address in ISO 3166 format.

Example:

"US"

items.billing_details.address.postal_code

string | null

The postal code or zip code for the address.

Required string length: 1 - 50

Example:

"94560"

items.billing_details.address.state

string | null

The state, county, or province for the address.

Required string length: 1 - 255

Example:

"California"

items.billing_details.address.state_code

string | null

The code of state, county, or province for the address in ISO 3166-2 format.

Example:

"US-CA"

items.billing_details.address.house_number_or_name

string | null

The house number or name for the address. Not all payment services use this field but some do.

Required string length: 1 - 255

Example:

"10"

items.billing_details.address.line1

string | null

The first line of the address.

Required string length: 1 - 255

Example:

"Stafford Appartments"

items.billing_details.address.line2

string | null

The second line of the address.

Required string length: 1 - 255

Example:

"29th Street"

items.billing_details.address.organization

string | null

The optional name of the company or organisation to add to the address.

Required string length: 1 - 255

Example:

"Gr4vy"

items.billing_details.tax_id

TaxId · object

The tax ID information associated with the billing details.

Show child attributes

items.billing_details.tax_id.value

string

required

The tax ID for the buyer.

Required string length: 1 - 50

items.billing_details.tax_id.kind

enum<string>

required

The kind of tax ID

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,

co.itin,

co.nit,

es.cif,

eu.vat,

gb.vat,

hk.br,

id.nik,

id.npwp,

in.gst,

in.pan,

jp.cn,

jp.rn,

kr.brn,

li.uid,

mx.curp,

mx.rfc,

my.frp,

my.itn,

my.nric,

my.sst,

no.vat,

nz.gst,

pe.ruc,

ph.tin,

ru.inn,

ru.kpp,

sa.vat,

sg.gst,

sg.uen,

th.id,

th.vat,

tw.vat,

us.ein,

za.vat,

bo.ci,

uy.rut,

uy.ci

items.account_number

string | null

The buyer account number

Required string length: 1 - 200

limit

integer

default:20

The number of items for this page.

Required range: 1 <= x <= 100

next_cursor

string | null

The cursor pointing at the next page of items.

Required string length: 1 - 1000

Example:

"ZXhhbXBsZTE"

previous_cursor

string | null

The cursor pointing at the previous page of items.

Required string length: 1 - 1000

Example:

"Xkjss7asS"

Get or update transaction session

Add a buyer

⌘I

Introduction

Transactions

Buyers

Checkout Sessions

Payment links

Payment options

Refunds

Sessions

Instruments

Vault

Connections

Errors

Other

List all buyers

Authorizations

Headers

Query Parameters

Response