Testing credits on Sandbox

If you would like to simulate incoming credits in the Sandbox environment, you can use the following endpoints:

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/mock/notifications/credit

{
  "amount": 1630,
  "reference": "Payment to Acme Corp",
  "payId": "john.doe@acme.com", 
  "creditor": {
    "name": "Acme Corp Pty Ltd",
    "agentBic": "VLCPAU22XXX",
    "identification": {
      "type": "BBAN",
      "bsb": "572512", 
      "accountNumber": "76543216" 
    }
  },
  "debtor": {
    "name": "J Doe",
    "agentBic": "VLCPAU22XXX",
    "identification": {
      "type": "BBAN",
      "bsb": "321321",
      "accountNumber": "32132132"
    }
  }
}

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

Field	Type	Presence	Notes
`amount`	`integer`	required	Amount in cents, e.g., 100 = AUD 1.00
`reference`	`string`	required	Payment description entered by the payer
`payId`	`string`	required	Must be an active PayID registered to your account
`creditor`	`object`	required	Object for your Volt account
`creditor.name`	`string`	required	Up to 80 characters
`creditor.agentBic`	`string`	required	Must be `VLCPAU22XXX`
`creditor.identification`	`object`	required	Your Volt account number
`creditor.identification.type`	`string`	required	Must be `BBAN`
`creditor.identification.bsb`	`string`	required	The BSB for your Volt sandbox connect account
`creditor.identification.accountNumber`	`string`	required	The account number for your Volt sandbox connect account
`debtor`	`object`	required	Object for the payer’s bank account
`debtor.name`	`string`	required	Up to 80 characters
`debtor.agentBic`	`string`	required	Use `VLCPAU22XXX`
`debtor.identification`	`object`	required	Your customer’s account number
`debtor.identification.type`	`string`	required	Must be `BBAN`
`debtor.identification.bsb`	`string`	required	Any 6-digit string
`debtor.identification.accountNumber`	`string`	required	Any 8-digit string

Testing credits on Sandbox

Fields in body

On this page