just/mocks_
mockzilla.org →
Catalog /banking /Volt Real-time Payments

Volt Real-time Payments

PROVIDER · Volt SPEC v2024.04.11 · OpenAPI 3.0.3 MOCK · LIVE
▸ TRY IT
https://api.justmocks.com/volt
Open mock →

Mock Volt's real-time A2A payments API: initiate Open Banking payments, list banks, manage payouts and beneficiaries.

[01]

About

overview

Simulate Volt's Open Banking real-time payment API across 20 endpoints: OAuth token, bank discovery and lookup, payment creation (v1 and v2), payment status retrieval, refund detail queries, payout creation and status, and beneficiary management. Covers UK Faster Payments, SEPA Instant, and SEPA Credit Transfer rails. Note: this is a mockzilla simulation, not the live Volt API.

Endpoints
20 across 7 resource groups
Methods
GET 11 · POST 9 none deprecated
OpenAPI
3.0.3 spec version 2024.04.11
Source spec
100 KB · YAML
[02]

Endpoints

20 operations · 7 resource groups
POST /oauth
Authenticating with the API
oAuth2 password authentication
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 product guides area. Mocked via Mockzilla.
GET /banks/{id}
Banks and financial institutions
Bank details
View details about a single bank or financial institution
POST /v2/payments
Payments
New payment request
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 payment that Volt can support. Step-by-step instructions for payment initiation are available in our product guides area.
POST /dropin
Payments
New Embedded checkout
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 payment that Volt can support.v2. Step-by-step instructions for creating Embedded Checkout are available in our product guides area.
GET /payments
Payments
List payments
Reporting API available to fetch list of payments based on specific selection criteria
GET /payments/{id}
Payments
Payment details
Returns the full details of an existing payment that you've created througn the POST /payments endpoint. Simply supply the of the payment we returned when the payment was created. You can retrieve a filterable list of payments through the /payments endpoint. Available as a Mockzilla mock endpoint.
GET /payouts/beneficiaries
Payouts (Connect)
Eligible beneficiaries list
Payouts are only available when using Volt Connect For regulatory purposes, it's a closed-loop payout system, meaning you may only payout funds to a person or organisation you've previously received money from using Volt Connect. This endpoint will return a list of beneficiaries you are allowed send payouts to. Usage The list is paginated by default. More information Full details on payouts can be found in our comprehensive integration guides.
POST /payouts
Payouts (Connect)
New payout request
Payouts are only available when using Volt Connect This will create a payout request to send funds from your Connect account to a beneficiary. For regulatory purposes, it's a closed-loop payout system, meaning you may only payout funds to a person or organisation you've previously received money from using Volt Connect. Usage Pass the details of the payout you'd like to make in the body of the request. Approval Payouts don't require approval if you create them using the API. If you need to review payouts before sending, this workflow should take place on your own system before you call this endpoint. More information Full details on payouts can be found in our comprehensive integration guides.
GET /payouts
Payouts (Connect)
Payout list
Payouts are only available when using Volt Connect This will return a list of all existing payouts. Usage The list is paginated by default and can be filtered using the parameters shown in the request section below. More information Full details on payouts can be found in our comprehensive integration guides.
GET /payouts/{id}
Payouts (Connect)
Payout details
Payouts are only available when using Volt Connect This will return details of the selected payout, with approval update history. Usage Pass the id of the payout as part of the URL. More information Full details on payouts can be found in our comprehensive integration guides.
GET /payments/{id}/refund-details
Refunds (Connect)
Check refund eligibility
Refunds are only available when using Volt Connect Usage Pass the id of the existing payment in the URL to check whether this payment is eligible for a refund. More information Full details on how to request refunds, with full details of notifications you can expect, can be found in our comprehensive integration guides. Mockzilla mock: no signup, no API key.
POST /payments/{id}/request-refund
Refunds (Connect)
New refund request
Refunds are only available when using Volt Connect Usage Pass the id of the existing payment in the URL and the amount and reference for the refund in the body of the request. Checking eligibility before requesting a refund You can get the eligibility for a refund using GET /payments/{id}/refund-details More information Full details on how to use refunds, with details of notifications you can expect, can be found in our comprehensive integration guides.
POST /reports/payments
Reporting
Create payment report
This endpoint allows you to request a payment report for a specific period. Once requested, your report will be generated asynchronously and available at the /reports/id/download endpoint as a CSV file once it's been generated. Check on the availability status of your report using the /reports/{id} endpoint. The and may be a maximum of 92 days apart, so you can generate reports containing 3 months data. If you supply a for any merchant within your customer hierarchy, only that merchant's data will be returned. If a ID is not provided, the report will contain data for all merchants within your customer hierarchy.
POST /reports/connect/{bankAccountId}
Reporting
Create Connect report
This endpoint allows you to request a Connect report for a selected and specific period. Once requested, your report will be generated asynchronously and available at the /reports/id/download endpoint as a CSV file once it's been generated. Check on the availability status of your report using the /reports/{id} endpoint. The and may be a maximum of 92 days apart, so you can generate reports containing 3 months data.
POST /reports/refund
Reporting
Create Refund report
This endpoint allows you to request a refund report for a specific period. Once requested, your report will be generated asynchronously and available at the /reports/id/download endpoint as a CSV file once it's been generated. Check on the availability status of your report using the /reports/{id} endpoint. The and may be a maximum of 92 days apart, so you can generate reports containing 3 months data. If you supply a for any merchant within your customer hierarchy, only that merchant's data will be returned. If a ID is not provided, the report will contain data for all merchants within your customer hierarchy. If you supply an for Connect account, only data related to this account will be returned. If an ID is not provided, the report will contain data related to all Connect accounts.
POST /reports/auditlog
Reporting
Create Audit Log report
This endpoint initiates the generation of an audit log report for a specified time frame. Reports are generated asynchronously and, once ready, can be downloaded as CSV files from /reports/{id}/download. Use /reports/{id} to monitor the report's status. The period between startDate and endDate must not exceed 92 days, allowing for quarterly reports. Specifying a customerId filters the report to include data exclusively for that merchant. Without a customerId, the report covers all merchants in your customer hierarchy. Served by the Mockzilla mock runtime.
GET /reports
Reporting
Get available reports
This endpoint will allow you to fetch a list containing all the reports you've generated. Use the of the report to download it using the /reports/{id}/download endpoint. By default, it will return a complete list of reports for your entire customer hierarchy. Providing a in the query will allow you to limit the list to reports available for one particular merchant.
GET /reports/{id}
Reporting
Get report by ID
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 as a CSV file, use the /reports/{id}/download endpoint. Provide the returned when you requested the report.
GET /reports/{id}/download
Reporting
Download a report
This endpoint allows downloading a previously generated report in CSV format. Use the returned when you requested the report.
GET /payments/{paymentId}/name-match-score
PaymentsMatchmeter
Payment Match Score
This endpoint will allow accurately matches naming nuances between merchant inputs and end-user bank records