API references
Search documentation... ⌘K
API references
Open merchant dashboard
SDK API
All our references

Retrieve Payment Session

Retrieves a payment session by its ID. Returns the payment session details including payment status, amount, currency, and reference numbers.

Endpoint signature
POST https://api.reservepay.com/sdk/retrieve-payment-session HTTP/1.1
Content-Type: application/json
Accept: application/json
{
merchant_id: string,
installation_id: string,
payment_session_id: string,
}
Returns: object
New to Reservepay? Read our guide on how to call endpoints to get started.
Request arguments
merchant_id string

Required. Your merchant ID that uniquely identifies your account.

installation_id string

Required. The installation ID for this platform (e.g. your iOS app, Android app, website, or terminal).

payment_session_id string

Required. The ID of the payment session to retrieve.

Response attributes
Attribute Description
amount
string

The payment amount in the smallest currency unit (e.g. cents for USD).
currency
string

The currency code for the payment amount (e.g. 'THB', 'USD').
payment_method
string

The name of the payment method.
payment_captured_at
string

The date when the payment was captured in ISO 8601 format. Null if payment has not been captured.
status
string

The current status of the payment.
payment_ref1
string

First reference number for the payment. Can be used for external tracking or merchant-specific identifiers.
payment_ref2
string

Second reference number for the payment. Can be used for external tracking or merchant-specific identifiers.
payment_ref3
string

Third reference number for the payment. Can be used for external tracking or merchant-specific identifiers.
terminal_id
string

The ID of the terminal that created the payment session, if any.
Errors specific to this endpoint
NOT_FOUND

The merchant, installation, or payment session could not be found with the provided IDs.

Errors common to all endpoints
UNHANDLED_ERROR

This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.

INVALID_ARGUMENTS

This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.

BAD_VERSION

This error occurs when making requests to an API version that is either deprecated or not yet released. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.

CODE SAMPLES
curl
Learn how to run these code samples in your terminal by reading our guide.