Create Checkout

post https://global-api-sandbox.afterpay.com/v2/checkouts

🚧
The Readme API Simulator includes form elements for both required and optional Body Params. If not populated with values, Readme will send empty strings to the Afterpay Online API. Any optional parameter that is validated against a Model will need to have all of its required sub-params populated with non-empty values.
Therefore, to avoid receiving unexpected "400" responses from Afterpay, please fill out all fields of the simulation form with valid values. This is particularly important for the amount and currency sub-params of the amount, taxAmount and shippingAmount params.

Successful Response (201)

Returns a token, expiry date/time and checkout URL if successful.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

Errors

In addition to the PUT/POST Errors applicable to all POST endpoints, the following errors are specific to Create Checkout:

HTTP Status Code	errorCode	Description
422 Unprocessable Entity	`invalid_object`	One or more required fields were missing or invalid.
422 Unprocessable Entity	`unsupported_payment_type`	The `amount` is outside of the merchant's payment limits, as returned by Get Configuration.
422 Unprocessable Entity	`unsupported_currency`	One or more Money objects may have contained a currency that differs from the merchant's account currency.

Body Params

amount

object

required

Total amount for order to be charged to consumer.

consumer

object

required

The consumer requesting the order.

billing

object

Billing address.

shipping

object

required

Shipping address.

courier

object

Shipping Courier details.

description

string

Deprecated: A description of the order.

items

array of objects

An array of order items.

items

discounts

array of objects

An array of discounts.

discounts

merchant

object

merchantReference

string

The merchant’s id/reference that this order corresponds to.

taxAmount

object

The included tax amount after applying all discounts.

shippingAmount

object

The shipping amount.

Headers

Content-Type

string

required

Defaults to application/json

User-Agent

string

required

Defaults to Readme.io API Simulator

string

Defaults to application/json

Language

Credentials

Basic

base64


xxxxxxxxxx
38
1
curl --request POST \
2
     --url https://global-api-sandbox.afterpay.com/v2/checkouts \
3
     --header 'Accept: application/json' \
4
     --header 'Content-Type: application/json' \
5
     --header 'User-Agent: Readme.io API Simulator' \
6
     --data '
7
{
8
  "amount": {
9
    "amount": "0.00",
10
    "currency": "USD"
11
  },
12
  "consumer": {
13
    "givenNames": "Joe",
14
    "surname": "Consumer",
15
    "email": "test@example.com"
16
  },
17
  "billing": {
18
    "name": "Joe Consumer",
19
    "line1": "123 Fake Street"
20
  },
21
  "shipping": {
22
    "name": "Joe Consumer",
23
    "line1": "123 Fake Street"
24
  },
25
  "merchant": {
26
    "redirectConfirmUrl": "https://example.com/checkout/confirm",
27
    "redirectCancelUrl": "https://example.com/checkout/cancel"
28
  },
29
  "taxAmount": {

Click Try It! to start a request and see the response here!