POST
/
buyers
curl --request POST \
  --url https://api.{gr4vy_id}.gr4vy.app/buyers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "external_identifier": "412231123",
  "display_name": "John L."
}'
{
  "type": "buyer",
  "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
  "billing_details": {
    "type": "billing-details",
    "first_name": "John",
    "last_name": "Lunn",
    "email_address": "john@example.com",
    "phone_number": "+1234567890",
    "address": {
      "city": "London",
      "country": "GB",
      "postal_code": "789123",
      "state": "Greater London",
      "state_code": "GB-LND",
      "house_number_or_name": "10",
      "line1": "10 Oxford Street",
      "line2": "New Oxford Court",
      "organization": "Gr4vy"
    },
    "tax_id": {
      "value": "12345678931",
      "kind": "gb.vat"
    }
  },
  "created_at": "2013-07-16T19:23:00.000+00:00",
  "display_name": "John L.",
  "external_identifier": "user-789123",
  "merchant_account_id": "default",
  "updated_at": "2013-07-16T19:23:00.000+00:00",
  "account_number": "1234567"
}

This endpoint requires the buyers.write scope.

Authorizations

​
Authorization
string
header
required

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.

​
account_number
string | null

The source account number to perform an account funding transaction.

Required string length: 1 - 255

Response

201
application/json
Returns the buyer that was added.
​
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.

​
account_number
string | null

The source account number to perform an account funding transaction.

Required string length: 1 - 255

Was this page helpful?

List buyersGet buyer