Overview

The Buyer object represents a customer that pays money to your organization.

Methods

Create
Get
Get by External ID
Update
List

POST /buyer
Create a new buyer under your enterprise.

Body Parameters

string

Legal first name from your records.

string

Legal last name from your records.

string

Optional user identifier from your system. If set, Manifest will enforce uniqueness, e.g. attempts to create a second buyer for the same user will fail.This should be a stable value like a User ID, not something that might change like an email address or phone number. This value should not contain any sensitive information.

string

Email address from your records.

string

ID of the payment instrument to associate with the buyer, if you have one. Primary usage is migrating existing customers to Manifest.

object

User defined data that can be attached to the object. See the User Data page for details.

Example

// POST /buyer
{
    "first_name": "Paul",
    "last_name": "McCartney",
    "email": "paul@thebeatles.com",
}

{
    "id": "buy_XXXXX",
    "first_name": "Paul",
    "last_name": "McCartney",
    "email": "paul@thebeatles.com",
    "user_data": {},
    "created_at": "2024-01-26T21:18:16.704Z",
    "updated_at": "2024-01-26T21:18:16.704Z"
}

GET /buyer/:id
Retrieve a buyer by its ID.

Path Parameters

string

required

The ID of the buyer to retrieve.

Example

{
    "id": "buy_XXXXX",
    "external_id": "AB789",
    "first_name": "Paul",
    "last_name": "McCartney",
    "email": "paul@thebeatles.com",
    "user_data": {},
    "created_at": "2024-01-26T21:18:16.704Z",
    "updated_at": "2024-01-26T21:18:16.704Z"
}

GET /buyer/external/:external_id
Get details of one of your enterprise’s buyers by your own user identifier. (Must set external_id during buyer creation to use this method.)

Path Parameters

string

required

User identifier from your system.

Example

{
    "id": "buy_XXXXX",
    "external_id": "AB789",
    "first_name": "Paul",
    "last_name": "McCartney",
    "email": "paul@thebeatles.com",
    "user_data": {},
    "created_at": "2024-01-26T21:18:16.704Z",
    "updated_at": "2024-01-26T21:18:16.704Z"
}

PUT /account-connection/:id
Update data associated with one of your enterprise’s connections.

Path Parameters

string

required

The ID of the buyer to update.

Body Parameters

string

Legal first name from your records.

string

Legal last name from your records.

string

Email address from your records.

object

User defined data that can be attached to the object. See the User Data page for details.

Example

// PUT /account-connection/acon_XXXXX
{
    "first_name": "Linda",
    "email": "linda@gmail.com"
}

{
    "id": "buy_XXXXX",
    "external_id": "AB789",
    "first_name": "Linda",
    "last_name": "McCartney",
    "email": "linda@gmail.com",
    "user_data": {},
    "created_at": "2024-01-26T21:18:16.704Z",
    "updated_at": "2024-01-26T21:18:16.704Z"
}

GET /buyer
List all buyers associated with your enterprise.

Query Parameters

integer

The page number to return. Default is 1.

integer

The number of items to return per page. Default is 10.

Example

{
    "data": [
          {
              "id": "buy_XXXXX",
              "first_name": "Paul",
              "last_name": "McCartney",
              "email": "paul@thebeatles.com",
              "user_data": {},
              "created_at": "2024-01-26T21:18:16.704Z",
              "updated_at": "2024-01-26T21:18:16.704Z"
          },
          {
              "id": "buy_YYYYY",
              "first_name": "John",
              "last_name": "Lennon",
              "email": "john@thebeatles.com",
              "user_data": {},
              "created_at": "2024-01-26T21:18:16.704Z",
              "updated_at": "2024-01-26T21:18:16.704Z"
          },
          {
              "id": "buy_ZZZZZ",
              "first_name": "George",
              "last_name": "Harrison",
              "email": "george@thebeatles.com",
              "user_data": {},
              "created_at": "2024-01-26T21:18:16.704Z",
              "updated_at": "2024-01-26T21:18:16.704Z"
          },
    ],
    "pagination": {
        "page": 1,
        "page_size": 10,
        "total": 3
    }
}

Properties

string

Identifier for this buyer.

string

Legal first name from your records.

string

Legal last name from your records.

string

Email address from your records.

object

User defined data that can be attached to the object. See the User Data page for details.

string (read-only)

Embeddable form that allows your buyers to securely manage their payment method. You should not store this URL, as it may change over time. See Payment Methods for details.

object

The buyer’s stored payment card details. If null, the buyer has no stored card.

Show Object

string

Last 4 digits of the card

string

Card brand key (e.g. VISA, MASTERCARD, AMERICAN_EXPRESS, DISCOVER)

integer

Card expiration month (1-12)

integer

Card expiration year

Documentation

Sending Money

Receiving Money

Automations

Resources

Reference

Buyers

Overview

Methods

Body Parameters

Example

Path Parameters

Example

Path Parameters

Example

Path Parameters

Body Parameters

Example

Query Parameters

Example

Properties

​Overview

​Methods

​Body Parameters

​Example

​Path Parameters

​Example

​Path Parameters

​Example

​Path Parameters

​Body Parameters

​Example

​Query Parameters

​Example

​Properties

Overview

Methods

Body Parameters

Example

Path Parameters

Example

Path Parameters

Example

Path Parameters

Body Parameters

Example

Query Parameters

Example

Properties