Purchases
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
ID of buyer making the purchase.
Array of items in the purchase, each containing a name, description, amount_in_cents, and quantity info.
User defined data that can be attached to the object. See the User Data page for details.
Example
Properties
Identifier for this purchase.
ID of buyer making the purchase.
Status of purchase. One of:
| Status | Description |
|---|---|
created | Purchase has been created. |
pending | Payment is processing. |
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. |
reversed | Purchase has been reversed. |
canceled | Purchase has been canceled. |
refunded | Purchase has been refunded. |
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 amount of the purchase in cents.
Fee amount of the purchase in cents.
Net total amount of the purchase in cents. This amount will be deposited into your operating account.
URL to the receipt PDF for the purchase, once paid.
Brand of the payment card used for the purchase, if available.
Last 4 digits of the payment card used for the purchase, if available.
Array of activity log entries for the purchase, each containing an entry and date.
User defined data associated with the purchase.
Date and time when the purchase was created.
Date and time when the purchase was last updated.