Payouts

General testing

To test payouts, you need to create a valid Bank Account and create a Payout to it. You can use these test accounts:

IBAN test account

  • IBAN - FR7630004000031234567890143
  • BIC - BNPAFRPP

GB test account

  • AccountNumber - 55779911
  • SortCode - 200000

You can then use the Sandbox operations view of the Dashboard to process the payout.

Instant payout testing

To simulate the fallback to a standard payout from an instant payout due to a banking error, you can use the following IBAN account:

  • IBAN - FR541558929750ZZZZZZAC01915
  • BIC - CMBRFR2BXXX
Request example
1{
2 "AuthorId": "145397183",
3 "Tag": "IP banking error",
4 "DebitedFunds": {
5 "Currency": "EUR",
6 "Amount": 1000
7 },
8 "Fees": {
9 "Currency": "EUR",
10 "Amount": 10
11 },
12 "BankAccountId": "158988175",
13 "DebitedWalletId": "145397873",
14 "BankWireRef": "Postman",
15 "PayoutModeRequested":"INSTANT_PAYMENT"
16}

When viewing the payout, the API returns a fallbacked payout (i.e., the STANDARD mode was applied).

Response example
1{
2 "ModeRequested": "INSTANT_PAYMENT",
3 "ModeApplied": "STANDARD",
4 "FallbackReason": {
5 "Code": "001999",
6 "Message": "Generic Operation error"
7 },
8 "EndToEndId": "77a7f37820fd4e49910e6bd3c04c919c",
9 "Id": "158988302",
10 "Tag": "IP banking error",
11 "CreationDate": 1672235391,
12 "AuthorId": "145397183",
13 "CreditedUserId": null,
14 "DebitedFunds": {
15 "Currency": "EUR",
16 "Amount": 1000
17 },
18 "CreditedFunds": {
19 "Currency": "EUR",
20 "Amount": 990
21 },
22 "Fees": {
23 "Currency": "EUR",
24 "Amount": 10
25 },
26 "Status": "SUCCEEDED",
27 "ResultCode": "000000",
28 "ResultMessage": "Success",
29 "ExecutionDate": 1672235391,
30 "Type": "PAYOUT",
31 "Nature": "REGULAR",
32 "CreditedWalletId": null,
33 "DebitedWalletId": "145397873",
34 "PaymentType": "BANK_WIRE",
35 "BankAccountId": "158988175",
36 "BankWireRef": "Postman"
37}

To simulate a non-reachable bank account, use the IP1070 value for the BankWireRef parameter.

Request example
1{
2 "AuthorId":"142036728",
3 "DebitedFunds":{
4 "Currency":"EUR",
5 "Amount":1260
6 },
7 "Fees":{
8 "Currency":"EUR",
9 "Amount":12
10 },
11 "BankAccountId":"151986981",
12 "DebitedWalletId":"145389978",
13 "BankWireRef":"IP1070",
14 "PayoutModeRequested":"INSTANT_PAYMENT"
15}
Response
1{
2 "InstantPayout": {
3 "IsReachable": false,
4 "UnreachableReason": {
5 "Code": "130010",
6 "Message": "Generic operation error"
7 }
8 }
9}

The following unreachable reasons can be returned:

  • 130006 - technical error, please try again later
  • 130007 - Destination Bank is not reachable
  • 130008 - Duplicate transaction identified
  • 130009 - The destination IBAN is not valid
  • 130010 - Generic operation error