Skip to main content
POST
Fetch by Receipt ID
Retrieve a collection order using the receipt_id you supplied when creating it. Send that receipt ID in the request field id, not receipt_id. This differs from Fetch Order by ID, which expects Paytring’s order_id. Authenticate with HTTP Basic Auth using your API key and secret. Do not include key or hash in the request body.

Request example

The receipt ID must be a string between 5 and 75 characters.

Success response excerpt

The full response also includes customer, gateway, address, note, and timestamp fields. The top-level status describes whether the fetch succeeded. order.order_status describes the payment state. V1 orders can be fetched through this endpoint for the same business account and environment. Use the matching test or live credentials. You do not need to recreate existing orders or regenerate credentials for V2.

Errors and payment confirmation

Known authentication, validation, and lookup errors can return HTTP 200 with status: false and an error object. Always inspect the response body. Before updating your payment records, confirm order.order_status is success and match the receipt ID, amount, and currency against your expected order. A successful fetch or receipt of a webhook alone does not mean the payment succeeded. See Migrating collection requests from V1 for the endpoint changes and collection webhook considerations.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
id
string
required

The receipt_id you supplied when creating the order. This is not Paytring's order_id.

Required string length: 5 - 75
Example:

"DEMO202611030001"

Response

Inspect status. A successful fetch returns order; order.order_status is the payment state. Handled API errors can also return HTTP 200 with status false and error.

status
boolean
default:true
Example:

true

error
object

Present for a handled API error when status is false.

order
object