Skip to main content

Volt

Quick Start
  1. Sign up at volt.io and obtain API credentials
  2. Create a terminal in the Admin Console with the parameters below
  3. Start processing — the adapter is pre-built and ready to use

Go to Volt →

Overview

Volt payment integration

Provider IDvolt
CategoryBank Transfers
Websitevolt.io

Configuration

Required Parameters

ParameterDescription
base_urlbase URL API for payments
secondary_base_urlbase URL for refunds

Example Configuration

{
"env": "prod",
"base_url": "https://api.volt.io/",
"secondary_base_url": "https://api.volt.io/",
"api_key": "your_username",
"api_secret": "your_password",
"client_id": "your_client_id",
"client_secret": "your_client_secret"
}

Payment Flow

Payments via Open Banking (one-phase):

  1. OAuth authentication - retrieval access_token via POST /oauth:

    • grant_type="password"
    • client_id, client_secret, username, password
    • Retrieval access_token
  2. authorize - payment creation via POST /payments:

    • Bearer token authentication
    • amount (minor units), currency
    • paymentSystem: OPEN_BANKING_UK (GBP) or OPEN_BANKING_EU (EUR+)
    • openBankingUK/openBankingEU: type="SERVICES"
    • internalReference (transaction ID)
    • payer: reference, email, firstName, lastName
    • communication.return: success/failure/pending/cancel links
    • Retrieval payment ID and redirect URL
  3. status - status check via GET /payments/{payment_id}:

    • Bearer token authentication
    • Parsing status
  4. refund - refund via POST /payments/{payment_id}/request-refund:

    • On secondary_base_url!
    • amount (minor units), externalReference
    • Retrieval refund ID

Status Mapping

Provider Status4pay StatusDescription
CANCELLED_BY_USERcancelled

Resources