How to test payouts

Testing on Sandbox

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. Customers using one of our Connect banking providers, can also test the PAYOUT_REJECTED_BY_PROVIDER status. Tests can be performed using the API or in Fuzebox.

Payout test cases
To test status	Set this `amount`
PAYOUT_FAILED	`"amount": 1570`
PAYOUT_REJECTED_BY_PROVIDER	`"amount": 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.

Find out more about signing requests

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 payout notification with the X-Volt-Type of payout_failed in your payment notifications endpoint

Using the API

Using the Volt API, call the GET /payouts/beneficiaries endpoint, and use 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 payment, 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, and using the beneficiary data you looked up.
- 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 payout notification with the X-Volt-Type of PAYOUT_FAILED in your payout notifications endpoint

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 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 payout notification with the X-Volt-Type of PAYOUT_REJECTED_BY_PROVIDER in your payout notifications endpoint

Using the API

Using the Volt API, call the GET /payouts/beneficiaries endpoint, and find 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 payment, 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 and using the eligible beneficiary data you found.
- 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 payout notification with the X-Volt-Type of PAYOUT_REJECTED_BY_PROVIDER in your payout notifications endpoint