Skip to main content
GET

Authorizations

Authorization
string
header
required

OAuth2 client_credentials authorization. Obtain a new access_token when it expires.

Query Parameters

merchant_id
string | null

Optional business identifier, up to 20 characters. When supplied, it must belong to the authenticated merchant and match the target batch. Omit it or leave it empty to locate a batch across all businesses of that merchant.

Maximum string length: 20
batch_id
integer<int64> | null

Supply this or file_identifier; both must match the same batch when supplied together.

Required range: x >= 1
file_identifier
string | null

Supply this or batch_id; both must match the same batch when supplied together.

Required string length: 10
Pattern: ^[A-Za-z0-9_]{10}$
line_number
integer | null

Filter by exact logical line number, minimum 1. Combines with status when both are supplied; details remains an array.

Required range: x >= 1
page
integer | null
default:1

Page number, starting at 1; defaults to 1 when omitted or null.

Required range: x >= 1
page_size
integer | null
default:50

Records per page, range 1–200; defaults to 50 when omitted or null.

Required range: 1 <= x <= 200
status
enum<string> | null

Filter by one detail status. validation_failed: Detail validation failed; payment processing was not started; queued: Awaiting processing; processing: Processing; created_pending: Transaction created without a confirmed success or failure; the transaction may also have expired; payment_succeeded: Payment succeeded; payment_failed: Payment failed; system_failed: Processing error; verify the payment outcome.

Available options:
validation_failed,
queued,
processing,
created_pending,
payment_succeeded,
payment_failed,
system_failed,
null

Response

HTTP 200. code=0 means the lookup succeeded; code=1 indicates a business or authentication error; code=400 indicates invalid query parameters.

code
enum<integer>
required

Lookup succeeded; code is still 0 when the batch or individual details have failed.

Available options:
0
message
string
required

Result message; ok on success.

Example:

"ok"

data
object
required

Response data.