The GET /buyers API makes it possible to find a buyer by its display_name or external_identifier value.

curl -i -X GET "https://api.mattildapayments.com/buyers?search=fe26475d-ec3e-4884-9553-f7356683f7f9" \
    -H "Authorization: Bearer [JWT_TOKEN]"

The API returns any buyers for which either the display_name or external_identifier partially match. If no buyers could be found the returned items will be an empty list.

GET /buyers?external_identifier=fe26475d-ec3e-4884-9553-f7356683f7f9
{
  "items": [
    {
      "type": "buyer",
      "id": "fe26475d-ec3e-4884-9553-f7356683f7f9",
      "external_identifier": "412231123",
      "display_name": "John L.",
      "created_at": "2013-07-16T19:23:00.000Z",
      "updated_at": "2013-07-16T19:23:00.000Z"
    }
  ],
  "limit": 100,
  "next_page": null,
  "previous_page": null
}

Was this page helpful?

Suggest edits
Link card to buyerDelete a buyer