Report an Order

Report a purchase to Button by creating an Order record.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

Total value of the order. Includes any discounts, if applicable. Must exclude VAT, all other taxes, surcharges and any additional costs such as delivery. This value represents the commissionable total. Must be an integer >= 0. Example: 1234 for $12.34

string
required

Three-letter ISO currency code as specified in ISO 4217.

string
required

The Order ID unique to this order. Treated as an ASCII string. 255 character maximum.

string
required

ISO-8601 string representing the time the purchase was made by the user.

string
required

The Button source token. This field is optional to create an order, but is required for attribution. When testing your integration, you should send dummy source tokens to Button, in the following format: ^fakesrctok-[a-f0-9]{16}$ (e.g. fakesrctok-abcdef0123456789). URL safe string up to 255 characters.

customer
object
string

The customer-facing order ID. Treated as a UTF-8 string. 255 character maximum. Note: Use this field to report the order identifier as communicated to the customer.

line_items
object
string

Represents the channel in which the user transacted. Accepted values for this field are "app" and "webview".

string

Value indicating whether the total being passed on the order is a decimal value. Set this flag to override the default behavior. For example, pass true if the order total is $3.00 and the value for total is set to 3.00. Leave unset or pass false for the default behavior, where $3.00 is represented in total as 300.

string

In advanced usages, provide a specific finalization_date. Normally this value is set automatically by Button. See our Order API Best Practices guide for more details

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Choose an example:
application/json
text/plain