Get Payment By Token

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

Successful Response (200)

Returns a Payment object in response.

Connection Timeouts

TimeoutTime (Seconds)
Open10
Read20

Errors

In addition to the GET Errors applicable to all GET endpoints, the following errors are specific to Get Payment By Token:

HTTP Status CodeerrorCodeDescription
404 <br />Not Foundnot_foundNo Clearpay Order was found matching the token provided.
get/v2/payments/token:{token}

Request

  • Base URL: https://global-api-sandbox.afterpay.com
  • URL: https://global-api-sandbox.afterpay.com/v2/payments/token:{token}
  • Auth: HTTP basic

Path parameters

tokenstring required

Order token that was used to complete payment.

Headers

User-Agentstring required
Acceptstring

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.