Testing on sandbox

If you would like to simulate incoming credits on Sandbox environment, we can do that with use of the following endpoint:

POST https://api.sandbox.volt.io/notifications/mocker

{
  "voltPaymentId": "1ec66986-9174-420d-b72f-9367e6c1279e",
  "accountName": "Test Account",
  "currency": "EUR",
  "type": "payin",
  "status": "CONFIRMED",
  "receivedAt": "2024-01-03T02:30:00+01:00",
  "amount": 321,
  "reference": "test reference",
  "iban": null,
  "swiftBic": null,
  "accountNumber": "12345678",
  "sortCode": "123456",
  "payer": {
    "name": "John Doe",
    "iban": "PL17109024026987316159914944",
    "swiftBic": "BUKBGB22",
    "accountNumber": null,
    "sortCode": null
  },
  "customerId": "eeeeeeee-0001-eeee-eeee-eeeeeeeeeeee"
}

Fields in body

Field	Type	Presence	Notes
`voltPaymentId`	string	required	UUID – unique for each request
`accountName`	string	optional
`currency`	string	required	Should match the account
`type`	string	required
`status`	string	required
`receivedAt`	string	required	Please set to today’s date
`amount`	integer	required	Must be `321` to trigger a successful credit
`reference`	string	required
`iban`	string	conditional	Either `iban` or `sortCode` + `accountNumber` if iban is passed it must match the Volt Account’s iban
`swiftBic`	string	conditional
`accountNumber`	string	conditional	Either `sortCode` + `accountNumber` or `iban`
`sortCode`	string	conditional
`payer.name`	string	required
`payer.iban`	string	optional
`payer.swiftBic`	string	optional
`payer.accountNumber`	string	optional
`payer.sortCode`	string	optional
`customerId`	string	required	customer’s uuid

← Previous To your Volt Account

Next → Reporting

On this page
Fields in body