Get Payment By Token | Welcome to Afterpay Documentation

curl https://global-api-sandbox.afterpay.com/v1/payments/token:token \
     -H "User-Agent: Afterpay Online API Simulator" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>"

{
  "paymentId": "pay_1234567890abcdef",
  "orderId": "ord_0987654321fedcba",
  "status": "COMPLETED",
  "amount": {
    "currency": "USD",
    "value": "150.00"
  },
  "createdAt": "2024-06-10T14:22:35Z",
  "orderDetails": {
    "items": [
      {
        "name": "Wireless Bluetooth Headphones",
        "sku": "WH-1000XM4",
        "quantity": 1,
        "price": {
          "currency": "USD",
          "value": "150.00"
        }
      }
    ],
    "shippingAddress": {
      "line1": "123 Elm Street",
      "line2": "Apt 4B",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94107",
      "country": "US"
    }
  }
}

This endpoint retrieves an individual payment along with its order details.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

tokenstringRequired

Order token that was used to complete payment.

Response

Returns a Payment object in response.

Errors

404

Not Found Error

Connection Timeouts

Authentication

Path parameters

Headers

Response

Errors