Developer

API references

Search documentation... ⌘K

API references

Open merchant dashboard

Merchant API

- Available API versions
- Supported payment methods
- Find key
- List keys
- Revoke key
- Update key
- Get balance
- Find bank account
- Link bank account
- Set primary contact bank account
- Unlink bank account
- Update bank account
- 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
- 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 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
- 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
- Add terminal
- Disable terminal
- Enable terminal
- Filter terminals
- Find terminal
- List terminals
- Remove terminal
- Reset terminal
- Update terminal
- Find topup
- List topups
- List user invitations
- List users
- Disconnect webhook
- Find webhook
- List webhooks
- Pause webhook
- Reconnect webhook
- Resume webhook

All our references

Request Payout Export

Triggers a background process to generate a CSV export of payouts within the specified paid_at range (maximum 1 month).

An email notification is sent to the user when the export is ready.

Only one export can be in progress per user at a time. Stale exports (older than 1 hour) are ignored for rate-limiting purposes.

Endpoint signature

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

POST https://api.reservepay.com/merchants/request-payout-export HTTP/1.1

Content-Type: application/json

Accept: application/json

Authorization: Bearer <token>

{

start_at: string,

end_at: string,

format: string?,

}

Returns: object

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

Request arguments

start_at string

Required. ISO8601 datetime string for the start of the range.

end_at string

Required. ISO8601 datetime string for the end of the range.

format string

Optional. Currently supported: 'csv' (default: 'csv').

Allowed values:

csv

Response attributes

Attribute	Description
`export_id` string	The unique identifier of the export.
`type` string	The type of data exported.
`format` string	The file format of the export.
`status` string	The current status of the export.
`filters` object	The filters applied to the export.
`download_url` string	The URL to download the exported file (available if status is completed).
`failure_message` string	The error message if the export failed.
`created_at` number	The timestamp when the export was requested.
`requester_id` string	The unique identifier of the user who requested the export.
`requester_email` string	The email address of the user who requested the export.

Errors specific to this endpoint


              RATE_LIMIT_EXCEEDED

An export is already in progress. Please wait for it to complete.

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.