Buyers
Get buyer
Buyers
Get buyer
Gets the information about a buyer.
GET
/buyers/{buyer_id}
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/buyers/{buyer_id} \
--header 'Authorization: <authorization>'{
"billing_details": {
"address": {
"city": "London",
"country": "GB",
"house_number_or_name": "10",
"line1": "10 Oxford Street",
"line2": "New Oxford Court",
"organization": "Gr4vy",
"postal_code": "789123",
"state": "Greater London",
"state_code": "GB-LND"
},
"email_address": "john@example.com",
"first_name": "John",
"last_name": "Lunn",
"phone_number": "+1234567890",
"tax_id": {
"kind": "gb.vat",
"value": "12345678931"
},
"type": "billing-details"
},
"created_at": "2013-07-16T19:23:00.000+00:00",
"display_name": "John L.",
"external_identifier": "user-789123",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"merchant_account_id": "default",
"type": "buyer",
"updated_at": "2013-07-16T19:23:00.000+00:00"
}This endpoint requires the buyers.read scope. The buyers.billing-details.read scope is needed to see all personally identifiable information.
Authorizations
Authorizationheaderrequired
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
buyer_idrequired
string
The unique ID for a buyer.
Response
200 - application/json
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.
external_identifier
string | null
An external identifier that can be used to match the buyer against your own records.
id
string
The unique Gr4vy ID for this buyer.
merchant_account_id
string
The unique ID for a merchant account.
type
enum<string>
The type of this resource. Is always buyer.
Available options:
buyer updated_at
string
The date and time when this buyer was last updated in our system.
curl --request GET \
--url https://api.sandbox.{gr4vy_id}.gr4vy.app/buyers/{buyer_id} \
--header 'Authorization: <authorization>'{
"billing_details": {
"address": {
"city": "London",
"country": "GB",
"house_number_or_name": "10",
"line1": "10 Oxford Street",
"line2": "New Oxford Court",
"organization": "Gr4vy",
"postal_code": "789123",
"state": "Greater London",
"state_code": "GB-LND"
},
"email_address": "john@example.com",
"first_name": "John",
"last_name": "Lunn",
"phone_number": "+1234567890",
"tax_id": {
"kind": "gb.vat",
"value": "12345678931"
},
"type": "billing-details"
},
"created_at": "2013-07-16T19:23:00.000+00:00",
"display_name": "John L.",
"external_identifier": "user-789123",
"id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
"merchant_account_id": "default",
"type": "buyer",
"updated_at": "2013-07-16T19:23:00.000+00:00"
}