Find batch

API references

Search documentation... ⌘K

Merchant API

- available-api-versions
- supported-payment-methods
- find-key
- list-keys
- revoke-key
- update-key
- balance-history
- get-balance
- find-bank-account
- link-bank-account
- set-primary-contact-bank-account
- unlink-bank-account
- update-bank-account
- find-batch
- list-batches
- confirm-payment-link-batch
- create-payment-link-batch
- prepare-payment-link-batch
- find-invoice
- list-invoices
- list-monthly-billing-archives
- list-plans
- list-statements
- retrieve-current-plan
- retrieve-monthly-billing-archive
- select-plan
- confirm-branding-upload
- generate-branding-upload-url
- remove-branding-document
- retrieve-branding
- retrieve-branding-font
- update-branding
- find-card
- forget-card
- save-card
- set-default-card
- retrieve-checkout
- start-checkout
- add-contact
- filter-contacts
- list-contacts
- remove-contact
- retrieve-contact
- update-contact
- challenge-dispute
- concede-dispute
- confirm-dispute-evidence-upload
- escalate-dispute
- find-dispute
- generate-dispute-evidence-upload-url
- list-disputes
- list-disputes-by-payment
- retrieve-dispute-performance
- find-export
- list-exports
- request-contact-export
- request-payment-by-contact-export
- request-payment-export
- request-payout-by-contact-export
- request-payout-export
- disable-installation
- enable-installation
- find-installation
- list-installations
- reconfigure-installation
- remove-installation
- add-to-metadata-set
- list-metadata
- remove-from-metadata-set
- remove-in-metadata
- retrieve-metadata
- sync-metadata
- list-email-subscribers
- retrieve-email-subscriber
- retrieve-notification-topics
- subscribe-to-topics
- unsubscribe-from-all-topics
- add-payment-link
- clone-payment-link
- disable-payment-link
- enable-payment-link
- filter-payment-links
- find-payment-link
- list-payment-link-payments
- list-payment-links
- remove-payment-link
- abort-payment-on-terminal
- capture-payment
- filter-payments
- find-payment
- initiate-payment-flow
- list-activity-logs
- list-payment-activities
- list-payments
- list-payments-by-contact
- list-payments-by-terminal
- refund-payment
- request-payment
- resume-payment-on-terminal
- retrieve-refund-performance
- retrieve-sales-performance
- reverse-payment
- start-payment-on-terminal
- void-payment
- filter-payouts
- find-payout
- list-payout-activities
- list-payouts
- list-payouts-by-contact
- retrieve-primary-bank-account
- send-payout
- send-payout-to-contact
- set-primary-bank-account
- turn-off-auto-payout
- turn-on-auto-payout
- find-refund
- list-refunds-by-payment
- assign-role
- list-permissions
- list-roles
- list-api-request-logs
- add-terminal
- disable-terminal
- enable-terminal
- filter-terminals
- find-terminal
- list-terminals
- remove-terminal
- reset-terminal
- update-terminal
- add-topup
- filter-topups
- find-topup
- list-topups
- list-user-invitations
- list-users
- find-virtual-account
- list-virtual-accounts
- disconnect-webhook
- find-webhook
- list-webhooks
- pause-webhook
- reconnect-webhook
- resume-webhook

All our references

Retrieve a batch by ID, including its current status, any prepare or processing error, the preview download URL when prepare has completed, and the result download URL when processing has completed.

Endpoint signature

This endpoint requires an API key. Read our authentication guide for more information.

POST https://api.reservepay.com/merchants/find-batch HTTP/1.1

Content-Type: application/json

Accept: application/json

Authorization: Bearer <token>

{

batch_id: string,

}

Returns: object

New to Reservepay? Read our guide on how to call endpoints to get started.

Request arguments

batch_id string

Required. The unique identifier of the batch (bat_...).

Response attributes

Attribute	Description
`batch_id` string	Always present. The unique identifier of the batch.
`type` string	Always present. The type of records in this batch. Possible values: `PAYMENT_LINK` `PAYOUT`
`status` string	Always present. The current processing status of the batch. Possible values: `CREATED` `PREPARING` `PREPARED` `PROCESSING` `COMPLETED`
`output_url` string	Nullable. The URL to download the result xlsx file. Present when the batch has completed.
`preview_url` string	Nullable. The URL to download the validated drafts JSON. Included after prepare has completed.
`error_message` string	Nullable. The failure reason when prepare or processing did not complete. Included when a background job failed.
`created_at` number	Always present. The timestamp when the batch was created.

Errors specific to this endpoint


          NOT_FOUND

The batch was not found.

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.

Open in Markdown