Get Payment By Order ID

GET

https://global-api-sandbox.afterpay.com/v1/payments/:orderId/environment::environment

GET

/v1/payments/:orderId/environment::environment

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

{
  "paymentId": "pay_7f8e9d6c-1234-4a56-b789-0a1b2c3d4e5f",
  "orderId": "ORD-20240615-123456",
  "status": "COMPLETED",
  "amount": {
    "currency": "AUD",
    "value": 149.99
  },
  "paymentMethod": "Afterpay",
  "createdAt": "2024-06-15T10:15:30Z",
  "orderDetails": {
    "items": [
      {
        "sku": "SKU-12345",
        "name": "Wireless Bluetooth Headphones",
        "quantity": 1,
        "unitPrice": {
          "currency": "AUD",
          "value": 149.99
        }
      }
    ],
    "totalAmount": {
      "currency": "AUD",
      "value": 149.99
    }
  }
}

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

environmentstringRequired

Use api-sandbox for AU/NZ, or api.us-sandbox for US.

orderIdstringRequired

The unique ID of the Afterpay Order, for which a Payment event has been completed.

Response

Returns a Payment object in response.

Errors

404

Not Found Error

Connection Timeouts

Authentication

Path parameters

Headers

Response

Errors