VoltDocs
Login to Fuzebox
Get startedAPI ReferenceImplementationBranding
Volt Gateway API (legacy)Payments

Payment details

GET
/payments/{id}

Returns the full details of an existing payment that you've created througn the POST /payments endpoint. Simply supply the id of the payment we returned when the payment was created.

You can retrieve a filterable list of payments through the GET /payments endpoint.

Authorization

oauth
AuthorizationBearer <token>

OAuth2 password grant - see the documentation in the oAuth2 Authentication section

In: header

Path Parameters

id*string

ID of the payment

Formatuuid

Response Body

application/json

curl -X GET "https://api.sandbox.volt.io/payments/93b85f3c-76eb-4316-b1ae-f3370ddc59bc"
{
  "id": "662384a0-9734-4556-a8bd-3f1e774e2a3c",
  "active": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "currency": {
    "id": "EUR",
    "name": "Euro",
    "decimal": 2,
    "active": true
  },
  "amount": 12345,
  "type": "OTHER",
  "account": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "active": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "nickname": "Virtual EUR CY Account",
    "accountNumber": null,
    "iban": "DE3339010517382289891",
    "swiftBic": "BARCGB2L",
    "currency": {
      "id": "EUR",
      "name": "Euro",
      "decimal": 2,
      "active": true
    },
    "country": {
      "id": "GB",
      "name": "United Kingdom"
    },
    "bankname": null
  },
  "uniqueReference": "sale123456",
  "bank": {
    "id": "662384a0-9734-4556-a8bd-3f1e774e2a3c",
    "name": "Barclays Bank",
    "country": {
      "id": "GB",
      "name": "United Kingdom"
    },
    "officialName": "Barclays Bank Plc",
    "branchName": "Barclays Bank Branch Plc",
    "shortBranchName": "Barclays Bank Branch",
    "active": true,
    "logo": "https://cdn.volt.io/banks/logos/xx_barclays_bank.png",
    "icon": "https://cdn.volt.io/banks/icons/xx_barclays_bank.png"
  },
  "status": "NEW_PAYMENT",
  "statusUpdates": [
    {
      "createdAt": "2023-02-16T09:42:37+00:00",
      "newStatus": "NEW_PAYMENT"
    }
  ],
  "beneficiary": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "accountIdentifications": [
      {
        "type": "string",
        "value": "string"
      }
    ],
    "country": {
      "id": "GB",
      "name": "United Kingdom"
    }
  },
  "transferType": null,
  "sender": {
    "name": "Jane Doe",
    "email": "jane@example.com",
    "ip": "151.152.153.154",
    "deviceFingerprint": "c1fc9f277826d16825940603196ab037",
    "voltConnect": {
      "accountName": "Jane Doe",
      "accountNumber": "12345678",
      "sortCode": "12345"
    }
  },
  "refundAvailable": false,
  "refundNotAvailableReason": "This payment cannot be refunded because it was not received",
  "refundNotAvailableCode": "ApiPaymentNotReceived"
}

oAuth2 password authentication POST

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 [integration guides](https://docs.volt.io/gateway/authentication/) area.

List payments GET

Reporting API available to fetch list of payments based on specific selection criteria