Get Payment By Order ID
This endpoint retrieves an individual payment along with its order details.
Successful Response (200)
Returns a Payment object in response.
Connection Timeouts
| Timeout | Time (Seconds) |
|---|---|
| Open | 10 |
| Read | 20 |
Errors
In addition to the GET Errors applicable to all GET endpoints, the following errors are specific to Get Payment By Order ID:
| HTTP Status Code | errorCode | Description |
|---|---|---|
| 404 <br />Not Found | not_found | No Clearpay Order was found matching the orderId provided. |
get/v1/payments/{orderId}
Request
- Base URL: https://global-api-sandbox.afterpay.com
- URL: https://global-api-sandbox.afterpay.com/v1/payments/{orderId}
- Auth: HTTP basic
Path parameters
orderIdstring required
The unique ID of the Clearpay Order, for which a Payment event has been completed.
Headers
User-Agentstring required
Acceptstring
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.