Loading...
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"
  }
}

Fields in body

FieldTypePresenceNotes
voltPaymentIdstringrequiredUUID – unique for each request
accountNamestringoptional
currencystringrequiredMust match the Volt account
typestringrequired
statusstringrequired
receivedAtstringrequiredSet to today's date
amountintegerrequiredMust be 321 to trigger a successful credit
referencestringrequired
ibanstringconditionalEither iban or sortCode + accountNumber or
bsb + accountNumber
if iban is passed it must match your Volt Account's IBAN
swiftBicstringconditional
accountNumberstringconditionalEither sortCode + accountNumber or
bsb + accountNumber or iban
if accountNumber is passed it must match your Volt Account's account number
sortCodestringconditionalEither sortCode + accountNumber or bsb + accountNumber or iban
if sortCode is passed it must match your Volt Account's sort code
bsbstringconditionalEither bsb + accountNumber or sortCode + accountNumber or iban
if bsb is passed it must match your Volt Account's BSB
payIdstringconditionalRequired for AUD manual credits: the PayID for your customer
payer.namestringrequired
payer.ibanstringoptional
payer.swiftBicstringoptional
payer.accountNumberstringconditionalMust be 641777848 for AUD
payer.sortCodestringoptional
payer.financialInstitutionstringconditionalMust be 016010 for AUD
customerIdstringrequiredYour Volt customer UUID
virtualAccountIdstringoptionalUUID – unique for each request
virtualAccountIdentifiers.ibanstringoptionalrequired if you would like to test Virtual Accounts
virtualAccountIdentifiers.swiftBicstringoptional

How is this guide?

Last updated on

On this page