Testing payouts

We have created an automated process to enable you to test both CONFIRMED and FAILED scenarios using our Sandbox environment by simply varying the amount of the refund. If you are using Connected Accounts, you can also test the PAYOUT_REJECTED_BY_PROVIDER status. Tests can be performed via the API or in Fuzebox.

To test status	Set this `amount`
`PAYOUT_FAILED`	`1570`
`PAYOUT_REJECTED_BY_PROVIDER`	`2570`
`PAYOUT_CONFIRMED`	any other

Testing the signing of your Payout request can only be completed in the production environment. We suggest creating a small payment then creating a Payout for this amount to test that your signature works.

Test a failed payout

You can also test a failed Payout using Fuzebox or the Connect API. It’s important that when you’re creating your Payout, you use a value of exactly 1570. This will automatically trigger the Payout to fail when you request it.

Using Fuzebox

In Fuzebox, create a Payout with an amount of 1570 minor units.

Check the status

The Payout should transition to the PAYOUT_FAILED status.

Check the notification

You should receive the corresponding with the X-Volt-Type of payout_failed in your payment notifications endpoint.

Using the API

Using the Volt API, specify the name and IBAN, or account number and sort code, of one of the eligible beneficiaries returned to use for this test. Although it’s a test transaction, the data sent must be as it would be in production.
Using the Volt API, create a POST to /payouts with an amount of 1570 minor units.
- If you’re using an IBAN, use EUR as the currency. If using account number and sort code, use GBP.

POST https://api.sandbox.volt.io/payouts

{
  "amount": 1570,
  "currency": "EUR",
  "paymentTitle": "Failure test",
  "beneficiary": {
    "name": "John Johnson",
    "iban": "DE07500105176551562526"
  }
}

Check the status

The payout should transition to the PAYOUT_FAILED status.

Check the notification

You should receive a corresponding with the X-Volt-Type of payout_failed in your .

Test rejected by provider

You can test a Payout that gets rejected by a provider using Fuzebox or the Connect API in the Sandbox environment. It’s important that when you create a payout, you use the amount of exactly 2570. This triggers the Payout to be rejected by the provider when you request it.

Using Fuzebox

In Fuzebox, create a Payout with an amount of 2570 minor units.

Check the status

The Payout should transition to the PAYOUT_REJECTED_BY_PROVIDER status.

Check the notification

You should receive the corresponding with the X-Volt-Type of payout_rejected_by_provider in your Payout notifications endpoint.

Using the API

Using the Volt API, specify the name and IBAN, or account number and sort code, of one of the eligible beneficiaries returned to use for this test. Although it’s a test transaction, the data sent must be as it would be in production.
Using the Volt API, create a POST to /payouts with an amount of 2570 minor units.
- If you’re using an IBAN, use EUR as the currency. If using account number and sort code, use GBP.

POST https://api.sandbox.volt.io/payouts

{
  "amount": 2570,
  "currency": "EUR",
  "paymentTitle": "Rejected by provider test",
  "beneficiary": {
    "name": "John Johnson",
    "iban": "DE07500105176551562526"
  }
}

Check the status

The Payout should transition to the PAYOUT_REJECTED_BY_PROVIDER status.

Check the notification

You should receive the corresponding with the X-Volt-Type of payout_rejected_by_provider in your .

Testing payouts

On this page