Skip to navigation
Online APIPayments

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

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 Order ID:

HTTP Status CodeerrorCodeDescription
404
Not Found		not_foundNo Clearpay Order was found matching the orderId provided.

Authentication

AuthorizationBasic

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

Path parameters

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

Headers

User-AgentstringRequired
AcceptstringOptionalDefaults to application/json