Overview

The Purchase object represents a one-time payment of money from a Buyer to your organization.

Methods

POST /purchase
Create a new purchase.

Body Parameters

buyer

string

required

ID of buyer making the purchase.

items

array

required

Array of items in the purchase, each containing a name, description, amount_in_cents, and quantity info.

auto_refund_on_fraud

boolean

default:false

If true, the purchase is eligible to be automatically refunded if a later fraud alert is detected on the payment card, minimizing the risk of chargebacks. A common use case is to set this to true if you are selling digital goods. Contact Manifest to configure your fraud refund window (default is 72 hours).

The Purchase status will be updated to refunded and you will receive a purchase.update webhook after the refund is processed.

user_data

object

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

Example

// POST /purchase
{
    "buyer": "buy_XXXXX",
    "items": [{
        "name": "Triangle Logo Tee",
        "description": "XL",
        "amount_in_cents": 3000,
        "quantity": 2
    }]
}

POST /purchase
Create a new purchase.

Body Parameters

buyer

string

required

ID of buyer making the purchase.

items

array

required

Array of items in the purchase, each containing a name, description, amount_in_cents, and quantity info.

auto_refund_on_fraud

boolean

default:false

The Purchase status will be updated to refunded and you will receive a purchase.update webhook after the refund is processed.

user_data

object

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

Example

// POST /purchase
{
    "buyer": "buy_XXXXX",
    "items": [{
        "name": "Triangle Logo Tee",
        "description": "XL",
        "amount_in_cents": 3000,
        "quantity": 2
    }]
}

POST /purchase/:id/commit
Execute purchase. Throws an error if the purchase is not in the created state.

Path Parameters

string

required

The ID of the purchase to execute.

Body Parameters

idempotency_id

string

An optional unique identifier for this request. If a second request is made with the same idempotency_id, the response will return an error.

Example

// POST /purchase/pch_YYYYY/commit
{
    "id": "pch_YYYYY",
    "buyer": "buy_XXXXX",
    "status": "pending",
    "items": [{
        "name": "Triangle Logo Tee",
        "description": "XL",
        "amount_in_cents": 3000,
        "quantity": 2
    }],
    "total_in_cents": 6000,
    "auto_refund_on_fraud": false,
    "user_data": {},
    "created_at": "2025-01-02T21:18:16.704Z",
    "updated_at": "2025-01-02T21:18:16.704Z"
}

GET /purchase/:id
Get details of one of your purchases.

Path Parameters

string

required

The ID of the purchase to retrieve.

Example

{
    "id": "pch_YYYYY",
    "buyer": "buy_XXXXX",
    "status": "created",
    "items": [{
        "name": "Triangle Logo Tee",
        "description": "XL",
        "amount_in_cents": 3000,
        "quantity": 2
    }],
    "total_in_cents": 6000,
    "auto_refund_on_fraud": false,
    "user_data": {},
    "created_at": "2025-01-02T21:18:16.704Z",
    "updated_at": "2025-01-02T21:18:16.704Z"
}

PUT /purchase/:id
Update data associated with one of your enterprise’s purchases. Since a checkout page may be rendered anytime after purchase creation, we do not let you update purchase fields that might materially change the nature of transaction.

Path Parameters

string

required

The ID of the purchase to update.

Body Parameters

status

string

The status of the purchase. Status can only be updated to canceled, completed, or refunded.

auto_refund_on_fraud

boolean

The Purchase status will be updated to refunded and you will receive a purchase.update webhook after the refund is processed.

user_data

object

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

Example

// PUT /purchase/pch_XXXXX
{
  "userdata": {
    "key": "value"
  }
}

GET /purchase
List all purchases from your enterprise.

Query Parameters

page

integer

The page number to return. Default is 1.

page_size

integer

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

Example

{
    "data": [
        {
            "id": "pch_XXXXX",
            "buyer": "buy_XXXXX",
            "status": "pending",
            "items": [{
                "name": "Triangle Logo Tee",
                "description": "XL",
                "amount_in_cents": 3000,
                "quantity": 2
            }],
            "total_in_cents": 6000,
            "auto_refund_on_fraud": false,
            "user_data": {},
            "created_at": "2025-01-02T21:18:16.704Z",
            "updated_at": "2025-01-02T21:18:16.704Z"
        },
        {
            "id": "pch_YYYYY",
            "buyer": "buy_XXXXX",
            "status": "pending",
            "items": [{
                "name": "Triangle Logo Tee",
                "description": "XL",
                "amount_in_cents": 3000,
                "quantity": 2
            }],
            "total_in_cents": 6000,
            "auto_refund_on_fraud": false,
            "user_data": {},
            "created_at": "2025-01-02T21:18:16.704Z",
            "updated_at": "2025-01-02T21:18:16.704Z"
        },
        {
            "id": "pch_ZZZZZ",
            "buyer": "buy_XXXXX",
            "status": "pending",
            "items": [{
                "name": "Triangle Logo Tee",
                "description": "XL",
                "amount_in_cents": 3000,
                "quantity": 2
            }],
            "total_in_cents": 6000,
            "auto_refund_on_fraud": false,
            "user_data": {},
            "created_at": "2025-01-02T21:18:16.704Z",
            "updated_at": "2025-01-02T21:18:16.704Z"
        },
    ],
    "pagination": {
        "page": 1,
        "page_size": 10,
        "total": 3
    }
}

GET /buyer/:id/purchase
List all purchases from your enterprise for a specific buyer.

Path Parameters

string

required

The ID of the buyer to list purchases for.

Query Parameters

page

integer

The page number to return. Default is 1.

page_size

integer

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

Example

{
    "data": [
        {
            "id": "pch_XXXXX",
            "buyer": "buy_XXXXX",
            "status": "pending",
            "items": [{
                "name": "Triangle Logo Tee",
                "description": "XL",
                "amount_in_cents": 3000,
                "quantity": 2
            }],
            "total_in_cents": 6000,
            "auto_refund_on_fraud": false,
            "user_data": {},
            "created_at": "2025-01-02T21:18:16.704Z",
            "updated_at": "2025-01-02T21:18:16.704Z"
        },
        {
            "id": "pch_YYYYY",
            "buyer": "buy_XXXXX",
            "status": "pending",
            "items": [{
                "name": "Triangle Logo Tee",
                "description": "XL",
                "amount_in_cents": 3000,
                "quantity": 2
            }],
            "total_in_cents": 6000,
            "auto_refund_on_fraud": false,
            "user_data": {},
            "created_at": "2025-01-02T21:18:16.704Z",
            "updated_at": "2025-01-02T21:18:16.704Z"
        },
        {
            "id": "pch_ZZZZZ",
            "buyer": "buy_XXXXX",
            "status": "pending",
            "items": [{
                "name": "Triangle Logo Tee",
                "description": "XL",
                "amount_in_cents": 3000,
                "quantity": 2
            }],
            "total_in_cents": 6000,
            "auto_refund_on_fraud": false,
            "user_data": {},
            "created_at": "2025-01-02T21:18:16.704Z",
            "updated_at": "2025-01-02T21:18:16.704Z"
        },
    ],
    "pagination": {
        "page": 1,
        "page_size": 10,
        "total": 3
    }
}

Properties

string

Identifier for this purchase.

buyer

string

ID of buyer making the purchase.

status

string

Status of purchase. One of:

Status	Description
`created`	Purchase has been created.
`pending`	Payment was successful, and money is being collected from the buyer.
`settling`	Payment is being settled to your operating account.
`completed`	Purchase has finished processing, and payment has been received in your operating account.
`error`	Purchase has encountered an error.
`canceled`	Purchase has been canceled.
`refunded`	Purchase has been refunded, and will be updated to `reversed` once the refund has been processed. If your attempt to refund a purchase fails, the payment will not be able to be reversed without a chargeback being processed.
`reversed`	Purchase has been reversed. This can happen if a refund is issued, or a chargeback is processed.

items

array

Array of items in the purchase, each containing a description, amount_in_cents, and meta data. You are responsible for adding items for tax and shipping, if applicable.

total_in_cents

number

Total amount of the purchase in cents.

fee_in_cents

number

Fee amount of the purchase in cents.

net_total_in_cents

number

Net total amount of the purchase in cents. This amount will be deposited into your operating account.

receipt_pdf_url

string

URL to the receipt PDF for the purchase, once paid.

payment_card_brand

string

Brand of the payment card used for the purchase, if available.

payment_card_last_four

string

Last 4 digits of the payment card used for the purchase, if available.

activity

array

Array of activity log entries for the purchase, each containing an entry and date.

auto_refund_on_fraud

boolean

default:false

The Purchase status will be updated to refunded and you will receive a purchase.update webhook after the refund is processed.

user_data

object

User defined data associated with the purchase.

created_at

string

Date and time when the purchase was created.

updated_at

string

Date and time when the purchase was last updated.

Documentation

Sending Money

Receiving Money

Resources

Reference

Purchases

Overview

Methods

Body Parameters

Example

Body Parameters

Example

Path Parameters

Body Parameters

Example

Path Parameters

Example

Path Parameters

Body Parameters

Example

Query Parameters

Example

Path Parameters

Query Parameters

Example

Properties

Documentation

Sending Money

Receiving Money

Resources

Reference

​Overview

​Methods

​Body Parameters

​Example

​Body Parameters

​Example

​Path Parameters

​Body Parameters

​Example

​Path Parameters

​Example

​Path Parameters

​Body Parameters

​Example

​Query Parameters

​Example

​Path Parameters

​Query Parameters

​Example

​Properties

Overview

Methods

Body Parameters

Example

Body Parameters

Example

Path Parameters

Body Parameters

Example

Path Parameters

Example

Path Parameters

Body Parameters

Example

Query Parameters

Example

Path Parameters

Query Parameters

Example

Properties