# Volt.io Real-time payments, everywhere. API

> Volt.io Real-time payments, everywhere. API on Apizie: 20 endpoints (oAuth2 password authentication, Bank details, New payment request, New Embedded checkout, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/payments:volt-io/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:volt-io`
- Category: Payments
- Status: byok
- Source: https://www.volt.io
- Page: https://www.apizie.tech/api/payments/volt-io
- OpenAPI: https://www.apizie.tech/api/payments/volt-io/openapi.json

Join the real-time revolution! Give your customers a faster, easier and safer way to pay. Volt has developed a REST API for merchants, allowing you to offer the option to use Open Banking payments on your online…

## Endpoints

### oAuth2 password authentication
`POST https://www.apizie.tech/v1/payments:volt-io/authenticating-with-the-api-using-oauth2-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Bank details
`GET https://www.apizie.tech/v1/payments:volt-io/banks-and-financial-institutions-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | UUID of the Bank |

### New payment request
`POST https://www.apizie.tech/v1/payments:volt-io/payments-submit-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### New Embedded checkout
`POST https://www.apizie.tech/v1/payments:volt-io/payments-initiate-embedded-checkout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### List payments
`GET https://www.apizie.tech/v1/payments:volt-io/payments-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | no | UUID of the Payment |
| bank | string | no | UUID of the Bank |
| currency | string | no | 3-letter currency code - See [ISO 4217 - Currency codes](https://www.iso.org/iso-4217-currency-codes.html) |
| amount | integer | no | The amount of the transaction in 1/100 units (pence, cents etc) |
| type | string | no | The transaction type (these are predefined) |
| uniqueReference | string | no | Unique reference for the payment |
| status | string | no | The current status of the payment |
| page | integer | no | You can request additional pages of information by appending the page parameter to your GET request. Pages start numbering at 1 and are in… |
| limit | integer | no | If you want to return more than the default number of records per page, append the parameter items to your GET request. To get the first… |

### Payment details
`GET https://www.apizie.tech/v1/payments:volt-io/payments-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the payment |

### Eligible beneficiaries list
`GET https://www.apizie.tech/v1/payments:volt-io/payouts-connect-eligible-beneficiaries-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no | Name of the beneficiary you'd like to send a payout to |
| accountNumber | string | no | Domestic account number for the beneficiary you'd like to send a payout to |
| iban | string | no | iban for the beneficiary you'd like to send a payout to |
| page | integer | no | You can request additional pages of information by appending the page parameter to your GET request. Pages start numbering at 1 and are in… |
| limit | integer | no | If you want to return more than the default number of records per page, append the parameter items to your GET request. To get the first… |

### Payout list
`GET https://www.apizie.tech/v1/payments:volt-io/payouts-connect-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | You can request additional pages of information by appending the page parameter to your GET request. Pages start numbering at 1 and are in… |
| limit | integer | no | If you want to return more than the default number of records per page, append the parameter items to your GET request. To get the first… |

### New payout request
`POST https://www.apizie.tech/v1/payments:volt-io/payouts-connect-create-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| idempotency-key | string | no | Recommended to avoid duplicate payout requests |
| X-JWS-Header | string | no | Optional - applicable if Volt is your Connect partner |
| body | object | no | JSON request body |

### Payout details
`GET https://www.apizie.tech/v1/payments:volt-io/payouts-connect-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the payout |

### Check refund eligibility
`GET https://www.apizie.tech/v1/payments:volt-io/refunds-connect-check-eligibility` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the refund |

### New refund request
`POST https://www.apizie.tech/v1/payments:volt-io/refunds-connect-create-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| idempotency-key | string | no | Optional - but recommended - to avoid duplicate refund requests |
| id | string | yes | ID of the payment |
| X-JWS-Header | string | no | Optional - applicable if Volt is your Connect partner |
| body | object | no | JSON request body |

### Create payment report
`POST https://www.apizie.tech/v1/payments:volt-io/reporting-create-payment-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Create Connect report
`POST https://www.apizie.tech/v1/payments:volt-io/reporting-create-connect-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| bankAccountId | string | yes | Connect bank account ID that you're requesting report for |
| body | object | no | JSON request body |

### Create Refund report
`POST https://www.apizie.tech/v1/payments:volt-io/reporting-create-refund-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Create Audit Log report
`POST https://www.apizie.tech/v1/payments:volt-io/reporting-create-audit-log-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get available reports
`GET https://www.apizie.tech/v1/payments:volt-io/reporting-get-available-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| customerId | string | no | The ID of a specific merchant within your customer hierarchy |

### Get report by ID
`GET https://www.apizie.tech/v1/payments:volt-io/reporting-get-report-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of the report you wish to retrieve |

### Download a report
`GET https://www.apizie.tech/v1/payments:volt-io/reporting-download-report-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | ID of report |

### Payment Match Score
`GET https://www.apizie.tech/v1/payments:volt-io/payments-check-match-score` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| paymentId | string | yes |  |
| allow_initials | boolean | no | default: true - if set to false, receiving an account holder name that contains an initial instead of a first name will significantly… |

## Example
```
curl "https://www.apizie.tech/v1/payments:volt-io/authenticating-with-the-api-using-oauth2-password" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Volt.io Real-time payments, everywhere. API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/payments:volt-io/authenticating-with-the-api-using-oauth2-password with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Volt.io Real-time payments, everywhere. API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Volt.io Real-time payments, everywhere. itself also needs your own key from api.volt.io.

### Can AI agents use the Volt.io Real-time payments, everywhere. API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:volt-io.

### What is the status of the Volt.io Real-time payments, everywhere. API?
Needs your own provider key (bring your own key)
