GET
/
buyers
curl --request GET \
  --url https://api.mattildapayments.com/buyers \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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": "mattilda Pay"
        },
        "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"
    }
  ],
  "limit": 1,
  "next_cursor": "ZXhhbXBsZTE",
  "previous_cursor": null
}

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.

Query Parameters

​
search
string

Filters the results to only the buyers for which the display_name or external_identifier matches this value. This field allows for a partial match, matching any buyer for which either of the fields partially or completely matches.

Example:

"John"

​
limit
integer
default:20

Defines the maximum number of items to return for this request.

Required range: 1 <= x <= 100
Example:

1

​
cursor
string

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.

Example:

"ZXhhbXBsZTE"

Response

200
application/json
Returns a list of buyers.

A list of buyers.