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

Find a payment

Retrieve details about a specific payment in your merchant account.

Endpoint signature
This endpoint requires an API key. Read our authentication guide for more information.
POST https://api.reservepay.com/merchants/find-payment HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer <token>
{
payment_id: string,
}
Returns: object
New to Reservepay? Read our guide on how to call endpoints to get started.
Request arguments
payment_id string

Required. The unique identifier of the payment to retrieve.

Response attributes
Attribute Description
payment_id
string

The ID of the payment.
external_id
string

Nullable. The merchant's internal reference for this payment.
status
string

The current status of the payment.
amount
number

The payment amount in subunits.
currency
string

The 3-letter ISO currency code (e.g., 'THB').
payment_method
string

The payment method used (e.g., 'PROMPTPAY', 'CARD').
created_at
number

The creation timestamp (Unix timestamp).
captured_at
number

Nullable. When the payment was captured (Unix timestamp).
expires_at
number

Nullable. When the payment expires (Unix timestamp).
capture
string

Whether the capture is automatic or manual.
customer_id
string

Nullable. The ID of the customer (contact) associated with this payment.
customer_email
string

Nullable. The email address of the customer.
customer_mobile
string

Nullable. The mobile phone number of the customer.
customer_name
string

Nullable. The name of the customer.
fees
array

The fees associated with the payment.
ref1
string

Nullable. The first custom reference (e.g., invoice ID).
ref2
string

Nullable. The second custom reference.
ref3
string

Nullable. The third custom reference.
reversible
boolean

Whether the payment can be reversed.
capturable
boolean

Whether the payment can be captured.
voidable
boolean

Whether the payment can be voided.
refundable
boolean

Whether the payment can be refunded.
fraud_finding
string

Whether the payment is considered risky or safe from a fraud perspective.
terminal_id
string

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

This error occurs when no payment with the provided ID exists in your merchant account. Double check that you're using the correct payment ID.

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 does not exist. 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.