Volt Gateway API (legacy)

View OpenAPI Schemas.

Authenticating with the api

oAuth2 password authentication POST

We use the industry-standard oAuth2 authentication to secure our API. Information you'll need - Your Client ID and Client Secret (from the...

Payments

Payment details GET

Returns the full details of an existing payment that you've created througn the POST /payments endpoint. Simply supply the id of the payment we...

List payments GET

Reporting API available to fetch list of payments based on specific selection criteria

Payment Match Score GET

This endpoint will allow accurately matches naming nuances between merchant inputs and end-user bank records

New embedded checkout request POST

The first step is to submit the details of the payment you'd like to initiate. We'll validate that all the required data is supplied and that it's a...

New payment request POST

The first step is to submit the details of the payment you'd like to initiate. We'll validate that all the required data is supplied and that it's a...

Reporting

Download a report GET

This endpoint allows downloading a previously generated report in CSV format. Use the id returned when you requested the report.

Get report by ID GET

This endpoint allows fetching the details of a specific report. Note that this will return the details of the report only. To download the report...

Get available reports GET

This endpoint will allow you to fetch a list containing all the reports you've generated. Use the id of the report to download it using the...

Create Audit Log report POST

This endpoint initiates the generation of an audit log report for a specified time frame. Reports are generated asynchronously and, once ready, can...

Create Connect report POST

This endpoint allows you to request a Connect report for a selected bankAccountId and specific period. Once requested, your report will be generated...

Create Payment report POST

This endpoint allows you to request a payment report for a specific period. Once requested, your report will be generated asynchronously and...

Create Payouts report POST

This endpoint allows you to request a payouts report for a specific period. Once requested, your report will be generated asynchronously and...

Create Refund report POST

This endpoint allows you to request a refund report for a specific period. Once requested, your report will be generated asynchronously and available...

How is this guide?

Last updated on

Payout status change notification Webhook

Sent to the notification URL when it was provided at payout creation; otherwise to the webhook URL configured in Fuzebox. | Type | Description | |-------|-------------| | `payout_processing` | Payout submitted for execution at the provider (`status` `PROCESSING`) | | `payout_completed` | Payout sent (`status` `COMPLETED`) | | `payout_failed` | Payout failed or was returned by the provider (`status` `FAILED`, see `failureReason`) | | `payout_cancelled` | Payout cancelled (`status` `CANCELLED`) | Each event is sent at most once, but `payout_processing` is **not guaranteed**: a payout that fails before it reaches the provider (for example, insufficient funds) goes straight to `payout_failed` without ever emitting `payout_processing`. Treat `payout_completed`, `payout_failed`, and `payout_cancelled` as the source of truth, and do not rely on receiving `payout_processing` beforehand. Delivery order is not guaranteed either, so do not rely on the order in which webhooks arrive: each payload is the payout's state at the moment it was sent, so a later-arriving webhook can validly describe an earlier moment than one you already received. Always take `status` from the payload itself rather than inferring it from arrival order.

oAuth2 password authentication POST

We use the industry-standard oAuth2 authentication to secure our API. ### Information you'll need - Your **Client ID** and **Client Secret** (from the application you created in Fuzebox) - Your **API username** and **password** (from the merchant credentials section in Fuzebox) Step-by-step instructions on how to authenticate are available in our [integration guides](https://docs.volt.io/gateway/authentication/) area.