Volt

https://docs.volt.io
Admin
Volt is a real-time account-to-account payment platform that connects domestic payment systems...
Tokens:60,435
Snippets:550
Trust Score:9.5
Update:1 week ago
Show doc for...
Tokens:
Raw
### Create a payment request example

Source: https://docs.volt.io/implementation/essentials/authentication

Example HTTP request to create a payment, including the Authorization header and Content-Type.

```http
POST https://api.volt.io/payments \
Authorization: Bearer YOUR_ACCESS_TOKEN \
Content-Type: application/json \
{ ... }
```

--------------------------------

### Example of paymentInitiationFlow object

Source: https://docs.volt.io/implementation/payments

Shows the structure of the paymentInitiationFlow object returned by the API, indicating the current status and next steps. In this example, the status is PROCESSING with a reason of AWAITING_USER_REDIRECT, providing both a redirect URL and a direct URL.

```json
{
  // ...
  "paymentInitiationFlow": {
    "status": "PROCESSING",
    "details": {
      "reason": "AWAITING_USER_REDIRECT",
      "redirect": {
        "url": "https://vo.lt/AB1XF",
        "directUrl": "https://myBank.com/authorisation?code=xyz"
      }
    }
  }
}
```

--------------------------------

### Internal transaction links example

Source: https://docs.volt.io/implementation/accounts/linking

Shows the _links object for an internal transaction, including self and correspondingInternal links with HTTPS hrefs and GET methods.

```json
{
  // ...
  "_links": {
    "self": {
      "href": "https://accounts.sandbox.volt.io/transactions/ba637b22-1077-4c39-9e48-2d20cd0c5b20",
      "method": "GET"
    },
    "correspondingInternal": {
      "href": "https://accounts.sandbox.volt.io/transactions/2b8e068f-b82e-49f0-8073-70f3c37434a3",
      "method": "GET"
    }
  }
}
```

--------------------------------

### GET /channels

Source: https://docs.volt.io/api-reference/stablecoins

Get list of channels. Channels are returned oldest first, without QR images.

```APIDOC
## GET /channels

### Description
Get list of channels. Channels are returned oldest first, without QR images.

### Method
GET

### Endpoint
/channels

```

--------------------------------

### GET /institutions

Source: https://docs.volt.io/api-reference/payments

Gets the list of institutions.

```APIDOC
## GET /institutions

### Description
Gets the list of institutions. All details can be used for creating an institution selection UI, along with required account identifiers inputs.

### Method
GET

### Endpoint
/institutions

### Parameters
No parameters documented.

### Request Example
No request example provided.

### Response
No response example provided.
```

--------------------------------

### GET /wallets

Source: https://docs.volt.io/api-reference/stablecoins

Get list of wallets. Wallets are returned oldest first, without deposit details.

```APIDOC
## GET /wallets

### Description
Get list of wallets. Wallets are returned oldest first, without deposit details.

### Method
GET

### Endpoint
/wallets

```

--------------------------------

### GET /accounts

Source: https://docs.volt.io/api-reference/accounts

Retrieves a list of all accounts.

```APIDOC
## GET /accounts

### Description
Retrieves a list of all accounts.

### Method
GET

### Endpoint
/accounts

### Response
#### Success Response (200)
- **accounts** (array) - List of account objects.

#### Response Example
{
  "accounts": []
}
```

--------------------------------

### GET Virtual accounts list

Source: https://docs.volt.io/api-reference/accounts-legacy

Returns a list of virtual accounts.

```APIDOC
## GET Virtual accounts list

### Description
Returns a list of virtual accounts.

### Method
GET

### Endpoint
Virtual accounts list

### Response
#### Success Response (200)
- **virtualAccounts** (array) - List of virtual accounts.

#### Response Example
{
  "virtualAccounts": []
}
```

--------------------------------

### GET Virtual IBANs list

Source: https://docs.volt.io/api-reference/accounts-legacy

Returns a list of virtual IBANs.

```APIDOC
## GET Virtual IBANs list

### Description
Returns a list of virtual IBANs.

### Method
GET

### Endpoint
Virtual IBANs list

### Response
#### Success Response (200)
- **virtualIBANs** (array) - List of virtual IBANs.

#### Response Example
{
  "virtualIBANs": []
}
```

--------------------------------

### GET /wallets/{id}

Source: https://docs.volt.io/api-reference/stablecoins

Fetch particular wallet details, including status, balance and deposit details.

```APIDOC
## GET /wallets/{id}

### Description
Fetch particular wallet details, including status, balance and deposit details.

### Method
GET

### Endpoint
/wallets/{id}

```

--------------------------------

### GET /institutions/countries

Source: https://docs.volt.io/api-reference/payments

Gets the list of countries in which institutions operate.

```APIDOC
## GET /institutions/countries

### Description
Gets the list of countries in which institutions operate. Useful for generating a bank's country switcher.

### Method
GET

### Endpoint
/institutions/countries

### Parameters
No parameters documented.

### Request Example
No request example provided.

### Response
No response example provided.
```

--------------------------------

### POST /reports

Source: https://docs.volt.io/api-reference/stablecoins

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 `startDate` and `endDate` may be a maximum of **92 days** apart, so you can generate reports containing 3 months data. If you supply a `customerId` for any merchant within your customer hierarchy, only that merchant's data will be returned. If a `customer ID` is **not** provided, the report will contain data for all merchants within your customer hierarchy. If you supply an `accountId` for Connect account, only data related to this account will be returned. If an `account ID` is **not** provided, the report will contain data related to all Connect accounts.

```APIDOC
## POST /reports

### Description
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 `startDate` and `endDate` may be a maximum of **92 days** apart, so you can generate reports containing 3 months data. If you supply a `customerId` for any merchant within your customer hierarchy, only that merchant's data will be returned. If a `customer ID` is **not** provided, the report will contain data for all merchants within your customer hierarchy. If you supply an `accountId` for Connect account, only data related to this account will be returned. If an `account ID` is **not** provided, the report will contain data related to all Connect accounts.

### Method
POST

### Endpoint
/reports

```

--------------------------------

### Create a verified payment in Sandbox with curl

Source: https://docs.volt.io/implementation/payments/integration-guides/verified-payment-guide

Use this curl command to create a verified payment in the Sandbox environment. The payer.reference 'redirect-2-step' and amount 200 trigger the redirect flow. The institution is not specified, so the payer selects it on the checkout.

```bash
curl --request POST \
  --url https://api.sandbox.volt.io/payments \
  --header 'authorization: Bearer <your access token>' \
  --header 'content-type: application/json' \
  --header 'idempotency-key: <your idempotency key>' \
  --header 'x-volt-api-version: 1' \
  --header 'x-volt-initiation-channel: api' \
  --header 'x-volt-verified-payment: true' \
  --data '{
    "currency": "EUR",
    "amount": 200,
    "paymentReference": "ABCDE12345F6GH78X9",
    "payer": {
      "email": "johndoe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "reference": "redirect-2-step"
    },
    "paymentSystem": "OPEN_BANKING_EU",
    "openBankingEU": {
      "type": "SERVICES"
    },
    "communication": {
      "return": {
        "urls": {
          "unified": { "url": "https://mywebsite.com/payment" }
        }
      },
      "notifications": {
        "url": "https://mywebsite.com/webhooks"
      }
    },
    "termsAndConditionsAccepted": true
  }'
```

--------------------------------

### GET Get list of transactions

Source: https://docs.volt.io/api-reference/accounts-legacy

Returns a list of transactions for a Volt account.

```APIDOC
## GET Get list of transactions

### Description
Returns a list of transactions for a Volt account.

### Method
GET

### Endpoint
Get list of transactions

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The ID of the account.

### Response
#### Success Response (200)
- **transactions** (array) - List of transactions.

#### Response Example
{
  "transactions": []
}
```

--------------------------------

### GET /wallet-transfers

Source: https://docs.volt.io/api-reference/stablecoins

Get list of wallet transfers. Transfers are returned oldest first.

```APIDOC
## GET /wallet-transfers

### Description
Get list of wallet transfers. Transfers are returned oldest first.

### Method
GET

### Endpoint
/wallet-transfers

```

--------------------------------

### POST /payments response with redirect URL

Source: https://docs.volt.io/implementation/payments/integration-guides/api-only-guide

Example response from POST /payments showing the paymentInitiationFlow with status PROCESSING and a redirect URL. The payer should be redirected to the provided URL for authorisation.

```json
{
  //...
  "paymentInitiationFlow": {
    "status": "PROCESSING",
    "details": {
      "reason": "AWAITING_USER_REDIRECT",
      "redirect": {
        "url": "https://vo.lt/short",
        "directUrl": "https://myBank.com/authorisation?code=xyz"
      }
    }
  }
  //...
}
```

--------------------------------

### Authorization header example

Source: https://docs.volt.io/implementation/essentials/authentication

Shows the format for including the access token in the Authorization header for API requests.

```http
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
```

--------------------------------

### GET /channels/{id}/payments

Source: https://docs.volt.io/api-reference/stablecoins

Get list of deposits received on the channel, oldest first.

```APIDOC
## GET /channels/{id}/payments

### Description
Get list of deposits received on the channel, oldest first.

### Method
GET

### Endpoint
/channels/{id}/payments

```

--------------------------------

### Create verified payment with curl (POST /payments)

Source: https://docs.volt.io/implementation/payments/integration-guides/verified-payment-guide

Use this curl command to create a verified payment. It includes the X-Volt-Verified-Payment: true header and the standard Open Banking payment body. The payer name is matched against the bank account holder name, so provide accurate firstName and lastName.

```bash
curl --request POST \
  --url https://gateway.volt.io/payments \
  --header 'authorization: Bearer <your access token>' \
  --header 'content-type: application/json' \
  --header 'idempotency-key: <your idempotency key>' \
  --header 'x-volt-api-version: 1' \
  --header 'x-volt-initiation-channel: api' \
  --header 'x-volt-verified-payment: true' \
  --data '{
    "currency": "EUR",
    "amount": 1000,
    "paymentReference": "ABCDE12345F6GH78X9",
    "internalReference": "your-internal-reference",
    "payer": {
      "email": "johndoe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "reference": "JDOE-101"
    },
    "device": {
      "ip": "192.168.0.1",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0",
      "fingerprint": "2aae6c35c94fcfb415dbe95f408b9ce91ee846ed"
    },
    "paymentSystem": "OPEN_BANKING_EU",
    "openBankingEU": {
      "type": "SERVICES",
      "institutionId": "<institution id>",
      "accountIdentifiers": {
        "iban": "DE75512108001245126199"
      }
    },
    "communication": {
      "return": {
        "urls": {
          "unified": { "url": "https://mywebsite.com/payment" }
        }
      },
      "notifications": {
        "url": "https://mywebsite.com/webhooks"
      }
    },
    "termsAndConditionsAccepted": true
  }'
```

--------------------------------

### Decoupled authorisation response example

Source: https://docs.volt.io/implementation/payments/integration-guides/api-only-guide

Shows the response returned when decoupled authorisation is required. The paymentInitiationFlow status is PROCESSING with reason AWAITING_DECOUPLED_AUTHORISATION.

```json
{
  //...
  "paymentInitiationFlow": {
    "status": "PROCESSING",
    "details": {
      "reason": "AWAITING_DECOUPLED_AUTHORISATION"
    }
  }
  //...
}
```

--------------------------------

### POST Create VIBAN for Account

Source: https://docs.volt.io/api-reference/accounts-legacy

Creates a virtual IBAN for a specified account.

```APIDOC
## POST Create VIBAN for Account

### Description
Creates a virtual IBAN for a specified account.

### Method
POST

### Endpoint
Create VIBAN for Account

### Request Body
- **accountId** (string) - Required - The ID of the account.
- **currency** (string) - Required - The currency of the virtual IBAN.

### Response
#### Success Response (200)
- **virtualIBAN** (object) - The created virtual IBAN.

#### Response Example
{
  "virtualIBAN": {}
}
```

--------------------------------

### Get report by ID GET

Source: https://docs.volt.io/api-reference/reporter

Fetches the details of a specific report. This returns the report details only, not the report content.

```APIDOC
## GET /reports/{id}

### Description
Fetches the details of a specific report. Note that this will return the details of the report only. To download the report, use the download endpoint.

### Method
GET

### Endpoint
`/reports/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the report.

### Response
#### Success Response (200)
- **id** (string) - The report ID.
- **status** (string) - The status of the report.
- **createdAt** (string) - The creation timestamp.

#### Response Example
```json
{
  "id": "123",
  "status": "ready",
  "createdAt": "2023-01-01T00:00:00Z"
}
```
```

--------------------------------

### POST /sandbox/incoming-transactions/{id}/reversal

Source: https://docs.volt.io/api-reference/accounts

Simulates a banking provider reversal notification for the specified incoming transaction. Only available in the sandbox environment.

```APIDOC
## POST /sandbox/incoming-transactions/{id}/reversal

### Description
Simulates a banking provider reversal notification for the specified incoming transaction. Only available in the sandbox environment.

### Method
POST

### Endpoint
/sandbox/incoming-transactions/{id}/reversal

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the incoming transaction.

### Response
#### Success Response (200)
- **status** (string) - The status of the reversal notification.

#### Response Example
{
  "status": "reversal_triggered"
}
```

--------------------------------

### POST /payments response (SCA App redirect)

Source: https://docs.volt.io/implementation/payments/integration-guides/api-only-guide

Example response from POST /payments when using API-only integration with X-Volt-Initiation-Channel: api. The paymentInitiationFlow status is PROCESSING with reason AWAITING_USER_REDIRECT, and the redirect object contains url and directUrl fields, where directUrl points to Volt's SCA App.

```json
{
  //...
  "paymentInitiationFlow": {
    "status": "PROCESSING",
    "details": {
      "reason": "AWAITING_USER_REDIRECT",
      "redirect": {
        "url": "https://vo.lt/short",
        "directUrl": "https://sca.volt.io/{paymentId}"
      }
    }
  }
  //...
}
```

--------------------------------

### Get available reports GET

Source: https://docs.volt.io/api-reference/reporter

Fetches a list of all reports you've generated. Use the report ID to download a specific report.

```APIDOC
## GET /reports

### Description
Fetches a list containing all the reports you've generated. Use the `id` of the report to download it using the download endpoint.

### Method
GET

### Endpoint
`/reports`

### Response
#### Success Response (200)
- **reports** (array) - List of report objects.
  - **id** (string) - The report ID.
  - **type** (string) - The report type.
  - **status** (string) - The report status.

#### Response Example
```json
{
  "reports": [
    {
      "id": "123",
      "type": "payments",
      "status": "ready"
    }
  ]
}
```
```

--------------------------------

### GET Get account access details

Source: https://docs.volt.io/api-reference/verify

Retrieves the account access details for the current user or organization. This endpoint is used to fetch information about how to access an account.

```APIDOC
## GET Get account access details

### Description
Retrieves the account access details for the current user or organization. This endpoint is used to fetch information about how to access an account.

### Method
GET

### Endpoint
(Endpoint not specified in source)

### Parameters
(No parameters documented in source)

### Request Example
(No request example provided in source)

### Response
#### Success Response
(Response schema not documented in source)

#### Response Example
(No response example provided in source)
```

--------------------------------

### POST /wallets

Source: https://docs.volt.io/api-reference/stablecoins

Create new wallet for the given currency. Whether the wallet is FIAT or CRYPTO is derived from the currency automatically. The first wallet a...

```APIDOC
## POST /wallets

### Description
Create new wallet for the given currency. Whether the wallet is FIAT or CRYPTO is derived from the currency automatically. The first wallet a...

### Method
POST

### Endpoint
/wallets

```

--------------------------------

### Transaction refunded by two partial refunds links example

Source: https://docs.volt.io/implementation/accounts/linking

Shows the _links object for a transaction refunded by two partial refunds, with refundedBy as an array of link objects.

```json
{
  // ...
  "_links": {
    "self": {
      "href": "https://accounts.sandbox.volt.io/transactions/ba637b22-1077-4c39-9e48-2d20cd0c5b20",
      "method": "GET"
    },
    "refundedBy": [
      {
        "href": "https://accounts.sandbox.volt.io/transactions/2b8e068f-b82e-49f0-8073-70f3c37434a3",
        "method": "GET"
      },
      {
        "href": "https://accounts.sandbox.volt.io/transactions/129af519-a903-4350-99b0-6c8834043487",
        "method": "GET"
      }
    ]
  }
}
```

--------------------------------

### GET /channels/{id}/rate

Source: https://docs.volt.io/api-reference/stablecoins

Get the current indicative rate for the channel's conversion. It is an estimate for showing at payment initiation, not a locked quote: the live rate...

```APIDOC
## GET /channels/{id}/rate

### Description
Get the current indicative rate for the channel's conversion. It is an estimate for showing at payment initiation, not a locked quote: the live rate...

### Method
GET

### Endpoint
/channels/{id}/rate

```

--------------------------------

### GET /payments/{id} response - payer view

Source: https://docs.volt.io/implementation/payments/integration-guides/verified-payment-guide

Payer-facing response when polling GET /payments/{id} while approval is pending. Shows a purely informational paymentInitiationFlow with status PROCESSING and reason AWAITING_CUSTOMER_APPROVAL.

```json
{
  "id": "fbd0a297-9c96-48c9-a85e-ef5d3d986e96",
  "status": "ADDITIONAL_AUTHORIZATION_REQUIRED",
  "paymentInitiationFlow": {
    "status": "PROCESSING",
    "details": {
      "reason": "AWAITING_CUSTOMER_APPROVAL"
    }
  }
  // ...
}
```

--------------------------------

### POST /mandates (Sandbox) — payer declines

Source: https://docs.volt.io/implementation/mandates

Creates a PayTo mandate in the Sandbox environment. Setting `payTo.limits.payment.amount` to `300` makes the payer decline, producing the `mandate_requested` → `mandate_declined` webhooks. Any other amount follows the happy path.

```json
{
  "currency": "AUD",
  "system": "PAY_TO",
  "mode": "RECURRING",
  "purpose": "SUBSCRIPTION",
  "payer": {
    "reference": "payer-ref-001",
    "email": "jane.smith@example.com"
  },
  "payTo": {
    "accountIdentifiers": {
      "accountName": "Jane Smith",
      "bsb": "062000",
      "accountNumber": "11111111"
    },
    "limits": {
      "periodic": {
        "period": "MONTH",
        "maxPaymentsCount": 3
      },
      "payment": {
        "amount": 300
      }
    },
    "description": "Sandbox — declined mandate"
  },
  "communication": {
    "notifications": {
      "url": "https://mysite.com/webhooks/mandates"
    },
    "return": {
      "urls": {
        "unified": {
          "url": "https://mysite.com/mandate/result"
        }
      }
    }
  }
}
```

--------------------------------

### POST /sandbox/incoming-transactions

Source: https://docs.volt.io/api-reference/accounts

Processes a simulated incoming transaction. This endpoint receives and processes a simulated incoming transaction.

```APIDOC
## POST /sandbox/incoming-transactions

### Description
Processes a simulated incoming transaction. This endpoint receives and processes a simulated incoming transaction.

### Method
POST

### Endpoint
/sandbox/incoming-transactions

### Request Body
- **account_id** (string) - Required - The account identifier.
- **amount** (number) - Required - The transaction amount.
- **currency** (string) - Required - The currency of the transaction.

### Request Example
{
  "account_id": "acc_123",
  "amount": 50.00,
  "currency": "USD"
}

### Response
#### Success Response (200)
- **transaction_id** (string) - The identifier of the simulated transaction.
- **status** (string) - The status of the transaction.

#### Response Example
{
  "transaction_id": "txn_sim_123",
  "status": "processed"
}
```

--------------------------------

### GET /channels/{id}/checkout-url

Source: https://docs.volt.io/api-reference/stablecoins

Get a link to the hosted Volt Checkout page for the channel. The page shows the payer the channel's deposit addresses, one per network, and the...

```APIDOC
## GET /channels/{id}/checkout-url

### Description
Get a link to the hosted Volt Checkout page for the channel. The page shows the payer the channel's deposit addresses, one per network, and the...

### Method
GET

### Endpoint
/channels/{id}/checkout-url

```

--------------------------------

### POST /payments

Source: https://docs.volt.io/implementation/payments/integration-guides/verified-payment-guide

Creates a verified payment. Requires the X-Volt-Verified-Payment: true header and the standard Open Banking payment body. The response returns the payment ID and a paymentInitiationFlow with a redirect URL for the payer to authorise.

```APIDOC
## POST /payments

### Description
Creates a verified payment. Requires the X-Volt-Verified-Payment: true header and the standard Open Banking payment body. The response returns the payment ID and a paymentInitiationFlow with a redirect URL for the payer to authorise.

### Method
POST

### Endpoint
https://gateway.volt.io/payments

### Headers
- **authorization** (string) - Required - Bearer token for authentication.
- **content-type** (string) - Required - application/json.
- **idempotency-key** (string) - Required - Idempotency key for the request.
- **x-volt-api-version** (string) - Required - API version, e.g., 1.
- **x-volt-initiation-channel** (string) - Required - Initiation channel, e.g., api.
- **x-volt-verified-payment** (boolean) - Required - Set to true to enable verified payment.

### Request Body
- **currency** (string) - Required - Currency code, e.g., EUR.
- **amount** (number) - Required - Payment amount in minor units.
- **paymentReference** (string) - Required - Payment reference.
- **internalReference** (string) - Optional - Internal reference.
- **payer** (object) - Required - Payer details.
  - **email** (string) - Required - Payer email.
  - **firstName** (string) - Required - Payer first name.
  - **lastName** (string) - Required - Payer last name.
  - **reference** (string) - Optional - Payer reference.
- **device** (object) - Required - Device information.
  - **ip** (string) - Required - IP address.
  - **userAgent** (string) - Required - User agent string.
  - **fingerprint** (string) - Required - Device fingerprint.
- **paymentSystem** (string) - Required - Payment system, e.g., OPEN_BANKING_EU.
- **openBankingEU** (object) - Required - Open Banking EU details.
  - **type** (string) - Required - Type, e.g., SERVICES.
  - **institutionId** (string) - Required - Institution ID.
  - **accountIdentifiers** (object) - Required - Account identifiers.
    - **iban** (string) - Required - IBAN.
- **communication** (object) - Required - Communication settings.
  - **return** (object) - Required - Return URLs.
    - **urls** (object) - Required - URLs.
      - **unified** (object) - Required - Unified URL.
        - **url** (string) - Required - Return URL.
  - **notifications** (object) - Required - Notification settings.
    - **url** (string) - Required - Webhook URL.
- **termsAndConditionsAccepted** (boolean) - Required - Must be true.

### Request Example
```
curl --request POST \
  --url https://gateway.volt.io/payments \
  --header 'authorization: Bearer <your access token>' \
  --header 'content-type: application/json' \
  --header 'idempotency-key: <your idempotency key>' \
  --header 'x-volt-api-version: 1' \
  --header 'x-volt-initiation-channel: api' \
  --header 'x-volt-verified-payment: true' \
  --data '{
    "currency": "EUR",
    "amount": 1000,
    "paymentReference": "ABCDE12345F6GH78X9",
    "internalReference": "your-internal-reference",
    "payer": {
      "email": "johndoe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "reference": "JDOE-101"
    },
    "device": {
      "ip": "192.168.0.1",
      "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0",
      "fingerprint": "2aae6c35c94fcfb415dbe95f408b9ce91ee846ed"
    },
    "paymentSystem": "OPEN_BANKING_EU",
    "openBankingEU": {
      "type": "SERVICES",
      "institutionId": "<institution id>",
      "accountIdentifiers": {
        "iban": "DE75512108001245126199"
      }
    },
    "communication": {
      "return": {
        "urls": {
          "unified": { "url": "https://mywebsite.com/payment" }
        }
      },
      "notifications": {
        "url": "https://mywebsite.com/webhooks"
      }
    },
    "termsAndConditionsAccepted": true
  }'
```

### Response
#### Success Response (200)
- **id** (string) - Payment ID.
- **status** (string) - Status, e.g., ADDITIONAL_AUTHORIZATION_REQUIRED.
- **paymentInitiationFlow** (object) - Flow details.
  - **status** (string) - Flow status, e.g., PROCESSING.
  - **details** (object) - Details.
    - **reason** (string) - Reason, e.g., AWAITING_USER_REDIRECT.
    - **redirect** (object) - Redirect URLs.
      - **url** (string) - Short redirect URL.
      - **directUrl** (string) - Direct bank authorisation URL.

#### Response Example
```
{
  "id": "fbd0a297-9c96-48c9-a85e-ef5d3d986e96",
  "status": "ADDITIONAL_AUTHORIZATION_REQUIRED", 
  "paymentInitiationFlow": {
    "status": "PROCESSING",
    "details": {
      "reason": "AWAITING_USER_REDIRECT",
      "redirect": {
        "url": "https://vo.lt/short",
        "directUrl": "https://myBank.com/authorisation?code=xyz"
      }
    }
  }
  // ...
}
```
```

--------------------------------

### POST /payments response (ADDITIONAL_AUTHORIZATION_REQUIRED)

Source: https://docs.volt.io/implementation/payments/integration-guides/verified-payment-guide

Example response from POST /payments showing the payment entering account-ownership verification with status ADDITIONAL_AUTHORIZATION_REQUIRED and a paymentInitiationFlow with a redirect URL for bank authorisation.

```json
{
  "id": "fbd0a297-9c96-48c9-a85e-ef5d3d986e96",
  "status": "ADDITIONAL_AUTHORIZATION_REQUIRED", 
  "paymentInitiationFlow": {
    "status": "PROCESSING",
    "details": {
      "reason": "AWAITING_USER_REDIRECT",
      "redirect": {
        "url": "https://vo.lt/short",
        "directUrl": "https://myBank.com/authorisation?code=xyz"
      }
    }
  }
  // ...
}
```

--------------------------------

### GET /trusted-accounts

Source: https://docs.volt.io/api-reference/accounts

Retrieves a list of trusted accounts.

```APIDOC
## GET /trusted-accounts

### Description
Retrieves a list of trusted accounts.

### Method
GET

### Endpoint
/trusted-accounts

### Response
#### Success Response (200)
- **trusted_accounts** (array) - List of trusted account objects.

#### Response Example
{
  "trusted_accounts": []
}
```

--------------------------------

### GET /aliases/orders/{id}

Source: https://docs.volt.io/api-reference/accounts

Retrieves the status of an alias order.

```APIDOC
## GET /aliases/orders/{id}

### Description
Retrieves the status of an alias order.

### Method
GET

### Endpoint
/aliases/orders/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the order.

### Response
#### Success Response (200)
- **order_id** (string) - The order identifier.
- **status** (string) - The current status of the order.

#### Response Example
{
  "order_id": "ord_alias_123",
  "status": "completed"
}
```

--------------------------------

### GET /aliases/{id}

Source: https://docs.volt.io/api-reference/accounts

Retrieves the details of a specific alias.

```APIDOC
## GET /aliases/{id}

### Description
Retrieves the details of a specific alias.

### Method
GET

### Endpoint
/aliases/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the alias.

### Response
#### Success Response (200)
- **id** (string) - The alias identifier.
- **state** (string) - The current state of the alias.

#### Response Example
{
  "id": "alias_123",
  "state": "active"
}
```
Tokens:
Raw