​
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
    }]
}

​
Properties

​
id
string
Identifier for this purchase.
​
buyer
string
ID of buyer making the purchase.
​
status
string
Status of purchase. One of:
StatusDescription
createdPurchase has been created.
pendingPayment was successful, and money is being collected from the buyer.
settlingPayment is being settled to your operating account.
completedPurchase has finished processing, and payment has been received in your operating account.
errorPurchase has encountered an error.
canceledPurchase has been canceled.
refundedPurchase 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.
reversedPurchase 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
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 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.