{ "aid": "sandbox.volt.io:main-2024.04.11", "name": "Real-time payments, everywhere.", "type": "Index", "description": "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 checkout.\n\n\n## NEW : API idempotency \n\nWe have introduced support for idempotency on the POST endpoints in the Volt Connect endpoints of the API. The idea of idempotency is to avoid unwanted duplication should a request to our API fail and need to be retried. \n\nUsing a unique idempotency key for each POST request, it is possible to safely retry the same call multiple times with the guarantee that it will only be actioned once.\n\n### Endpoints supporting idempotency\nIf an endpoint supports idempotent processing, we'll indicate this in the header documentation for that endpoint.\n\n### Using an idempotency key\n\nUsing the idempotency key is optional. If you would like to use it to help prevent duplicates in your POST requests, simply include the header ```idempotency-key: ``` - where `````` is a unique identifier for the message. We recommend using a **UUID** for the key, however you may use any other unique identifier you choose. \n\n### Retries\nIf the request times out or you don't receive a response for any other reason, you may safely retry it using the same payload and headers. Use the same key for the retried attempt. \n\n### Preventing duplicates \nIf we have already processed the request and you send a request using the same idempotency key, it will fail with an error, returning an HTTP code of ```409``` Conflict. \n\n### Exponential backoff for retries\nYou should adopt an exponential backoff strategy when retrying requests using the same idempotency key. For example, retry 1 second later then, if it fails again, 2 seconds later, 4 seconds later etc.\n", "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/sandbox.volt.io/main/2024.04.11/apis.json", "tags": [ "sandbox.volt.io", "main" ], "created": "2026-03-31", "modified": "2026-03-31", "specificationVersion": "0.19", "access": "3rd-Party", "maintainers": [ { "FN": "Jentic", "X-github": "jentic", "url": "https://github.com/jentic" } ], "apis": [ { "aid": "sandbox.volt.io:main-2024.04.11", "name": "Real-time payments, everywhere.", "description": "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 checkout.\n\n\n## NEW : API idempotency \n\nWe have introduced support for idempotency on the POST endpoints in the Volt Connect endpoints of the API. The idea of idempotency is to avoid unwanted duplication should a request to our API fail and need to be retried. \n\nUsing a unique idempotency key for each POST request, it is possible to safely retry the same call multiple times with the guarantee that it will only be actioned once.\n\n### Endpoints supporting idempotency\nIf an endpoint supports idempotent processing, we'll indicate this in the header documentation for that endpoint.\n\n### Using an idempotency key\n\nUsing the idempotency key is optional. If you would like to use it to help prevent duplicates in your POST requests, simply include the header ```idempotency-key: ``` - where `````` is a unique identifier for the message. We recommend using a **UUID** for the key, however you may use any other unique identifier you choose. \n\n### Retries\nIf the request times out or you don't receive a response for any other reason, you may safely retry it using the same payload and headers. Use the same key for the retried attempt. \n\n### Preventing duplicates \nIf we have already processed the request and you send a request using the same idempotency key, it will fail with an error, returning an HTTP code of ```409``` Conflict. \n\n### Exponential backoff for retries\nYou should adopt an exponential backoff strategy when retrying requests using the same idempotency key. For example, retry 1 second later then, if it fails again, 2 seconds later, 4 seconds later etc.\n", "image": "", "baseURL": "https://api.sandbox.volt.io", "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/sandbox.volt.io/main/2024.04.11", "version": "2024.04.11", "tags": [ "sandbox.volt.io", "main" ], "properties": [ { "type": "OpenAPI", "name": "OpenAPI definition", "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/sandbox.volt.io/main/2024.04.11/openapi.json", "mediaType": "application/openapi+json" }, { "type": "GitHubRepo", "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/sandbox.volt.io/main/2024.04.11" } ] } ] }