Query a TXT batch and its details
Retrieve a batch and its per-record processing results for the authenticated merchant, optionally filtered by business. Use an OAuth2 Bearer token; no request signature is required. Supply batch_id or file_identifier. When both are supplied, they must match the same batch.
line_number is the logical number in a D record; record_line_no is the physical file line number including the header. Results are paginated in ascending line_number order. line_number and status filters combine, and details is always an array. Use page 1 for a single-line lookup. pagination.total counts filtered records, while summary always covers all current details in the batch.
code=0 only means the lookup succeeded, even when the batch or details failed. Batch completed means transaction creation processing is complete; it does not guarantee payment success. Read both detail status and transaction_status. created_pending may also correspond to an expired transaction. details=[] can mean details are not yet available or no records match; it does not mean all payments succeeded. Transaction numbers and statuses may be null when unavailable; do not repeat payments on that basis.
Use OAuth credentials for the same merchant. merchant_id may be omitted or empty to locate the batch across all businesses of that merchant; when supplied, it must match the business identifier in the original upload. This lookup only returns processing results and does not execute payments again.
Authorizations
OAuth2 client_credentials authorization. Obtain a new access_token when it expires.
Query Parameters
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.
20Supply this or file_identifier; both must match the same batch when supplied together.
x >= 1Supply this or batch_id; both must match the same batch when supplied together.
10^[A-Za-z0-9_]{10}$Filter by exact logical line number, minimum 1. Combines with status when both are supplied; details remains an array.
x >= 1Page number, starting at 1; defaults to 1 when omitted or null.
x >= 1Records per page, range 1–200; defaults to 50 when omitted or null.
1 <= x <= 200Filter 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.
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.