Collections
Testing credits on Sandbox
How to simulate incoming credits in the Sandbox environment
If you would like to simulate incoming credits in the Sandbox environment, you can use 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-11-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",
"virtualAccountId": "65a4c575-df83-41f6-8333-21068b2a6864",
"virtualAccountIdentifiers": {
"iban": "DK2450517187342686",
"swiftBic": "DKNBDKKKXXX"
}
}POST https://api.sandbox.volt.io/notifications/mocker
{
"voltPaymentId": "1ec66986-9174-420d-b72f-9367e6c1279e",
"currency": "AUD",
"type": "payin",
"status": "CONFIRMED",
"receivedAt": "2026-01-01T02:30:00+11:00",
"amount": 321,
"reference": "test reference",
"accountNumber": "13311331",
"bsb": "321321",
"payId": "john.doe@example.com",
"payer": {
"name": "John Doe",
"accountNumber": "641777848",
"financialInstitution": "016010"
},
"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 | Must match the Volt account |
type | string | required | |
status | string | required | |
receivedAt | string | required | 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 or bsb + accountNumber if iban is passed it must match your Volt Account's IBAN |
swiftBic | string | conditional | |
accountNumber | string | conditional | Either sortCode + accountNumber or bsb + accountNumber or iban if accountNumber is passed it must match your Volt Account's account number |
sortCode | string | conditional | Either sortCode + accountNumber or bsb + accountNumber or iban if sortCode is passed it must match your Volt Account's sort code |
bsb | string | conditional | Either bsb + accountNumber or sortCode + accountNumber or iban if bsb is passed it must match your Volt Account's BSB |
payId | string | conditional | Required for AUD manual credits: the PayID for your customer |
payer.name | string | required | |
payer.iban | string | optional | |
payer.swiftBic | string | optional | |
payer.accountNumber | string | conditional | Must be 641777848 for AUD |
payer.sortCode | string | optional | |
payer.financialInstitution | string | conditional | Must be 016010 for AUD |
customerId | string | required | Your Volt customer UUID |
virtualAccountId | string | optional | UUID – unique for each request |
virtualAccountIdentifiers.iban | string | optional | required if you would like to test Virtual Accounts |
virtualAccountIdentifiers.swiftBic | string | optional |
How is this guide?
Last updated on