Introduction

Version

To see current version and details of recent changes, please see Changelog.

Actions

Action request headers are required to be sent as part of every request to the Bankbox API, so please make sure to setup them correctly before doing API calls.

Bank account

Get balances

URL Method
/api/v1/bank-account/balances GET

Response

Parameter Type Length Required Description
name string 100 Yes Bank account name.
balances BankAccountBalance Yes List of account balances.
{
    "status": "success",
    "requestId": 159,
    "data": {
        "name": "John Joe bank account",
        "balances": [
            {
                "amount": 456789,
                "currency": "826"
            },
            {
                "amount": 133548,
                "currency": "978"
            }
        ]
    }
}

Bank account address

Create

URL Method
/api/v1/bank-account-address/create POST

Request

Parameter Type Length Required Description
holder BankAccountHolder Yes Information about bank account holder.
type int 11 No BankAccountAddressType (used for some bank providers)
currency string 3 Yes Currency ISON.
accountName string 70 No Account name.
requestReference string 255 No Request reference.
{
    "holder": {
      "title": "Mr",
      "firstName": "John",
      "lastName": "Smith",
      "addressLineOne": "Bridge St",
      "postalCode": "SW1A 2PW",
      "city": "Westminster",
      "state": "London",
      "country": "826",
      "phone": "142544544"
    },
    "currency": "826",
    "requestReference": "123456789"
}

Response

Success
Parameter Type Required Description
BankAccountAddress Yes Information about successfully created bank account address.
{
  "status": "success",
  "requestId": 159,
  "data": {
    "id": 10,
    "accountNumber": "78572458",
    "accountName": "John Smith",
    "iban": "GB36SRLG04000000000000",
    "sortCode": "040059",
    "bic": "SRXXXXXX",
    "country": "826",
    "directCreditEnabled": false,
    "directDebitEnabled": false,
    "inboundEnabled": true,
    "outboundEnabled": true,
    "providerName": "CENTROLINK",
    "requestReference": "123456789"
  }
}

Update

URL Method
/api/v1/bank-account-address/update POST

Request

Parameter Type Length Required Description
bankAccountAddressId int 20 Yes BankAccountAddress->id.
type int 11 No BankAccountAddressType (used for some bank providers)
holder BankAccountHolderUpdate Yes Information about bank account holder. Fill in data only which you want to update
{
    "bankAccountAddressId": 2,
    "holder": {
      "firstName": "John",
      "lastName": "Smith",
      "addressLineOne": "Bridge St",
      "postalCode": "SW1A 2PW",
      "city": "Westminster",
      "state": "London",
      "country": "826",
      "phone": "142544544"
    }
}

Response

Success
Parameter Type Required Description
BankAccountAddress Yes Information about successfully created bank account address.
{
  "status": "success",
  "requestId": 159,
  "data": {
    "id": 2,
    "accountName": "John Smith",
    "accountNumber": "78572458",
    "iban": "GB36SRLG04000000000000", 
    "bban": null,
    "sortCode": "040059",
    "bic": "SRXXXXXX",
    "country": "826"
  }
}

Create business

URL Method
/api/v1/bank-account-address/create-business POST

Request

Parameter Type Length Required Description
company BankAccountCompany Yes Information about bank account company.
type int 11 No BankAccountAddressType (used for some bank providers)
currency string 3 Yes Currency ISON.
accountName string 70 No Account name.
requestReference string 255 No Request reference.
{
    "company": {
      "name": "Company name",
      "addressLineOne": "Bridge St"
    },
    "currency": "826",
    "requestReference": "123456789"
}

Response

Success
Parameter Type Required Description
BankAccountAddress Yes Information about successfully created bank account address.
{
  "status": "success",
  "requestId": 159,
  "data": {
    "id": 10,
    "accountNumber": "78572458",
    "accountName": "John Smith",
    "iban": "GB36SRLG04000000000000",
    "sortCode": "040059",
    "bic": "SRXXXXXX",
    "country": "826",
    "directCreditEnabled": false,
    "directDebitEnabled": false,
    "inboundEnabled": true,
    "outboundEnabled": true,
    "providerName": "CENTROLINK",
    "requestReference": "123456789"
  }
}
Partial success
Parameter Type Required Description
BankAccountAddress Yes Information about partly created bank account address. Full information will be provded via Bank account address - created notification.
{
  "status": "success",
  "requestId": 160,
  "data": {
    "id": 38,
    "accountName": "John Smith",
    "accountNumber": null,
    "iban": null,
    "sortCode": "040472",
    "bic": "SRXXXXXX",
    "country": null,
    "inboundEnabled": true,
    "outboundEnabled": true,
    "directCreditEnabled": false,
    "directDebitEnabled": false,
    "providerName": "CENTROLINK",
    "requestReference": "123456789"
  }
}

Update business

URL Method
/api/v1/bank-account-address/update-business POST

Request

Parameter Type Length Required Description
bankAccountAddressId int 20 Yes BankAccountAddress->id.
type int 11 No BankAccountAddressType (used for some bank providers)
company BankAccountCompanyUpdate Yes Information about bank account company. Fill in data only which you want to update
{
    "bankAccountAddressId": 2,
    "company": {
      "name": "Company name",
      "addressLineOne": "Bridge St"
    }
}

Response

Success
Parameter Type Required Description
BankAccountAddress Yes Information about successfully created bank account address.
{
  "status": "success",
  "requestId": 159,
  "data": {
    "id": 2,
    "accountName": "John Smith",
    "accountNumber": "78572458",
    "iban": "GB36SRLG04000000000000",
    "bban": null,
    "sortCode": "040059",
    "bic": "SRXXXXXX",
    "country": "826"
  }
}

Get details

URL Method
/api/v1/bank-account-address/get POST

Request

Parameter Type Length Required Description
bankAccountAddressId int 20 Conditional BankAccountAddress->id. Required if RequestReference is not provided.
requestReference string 255 Conditional Required if BankAccountAddressId is not provided
{
    "bankAccountAddressId": 2,
    "requestReference": "AZ123456789"
}

Response

Parameter Type Required Description
BankAccountAddress Yes Information about bank account address.
{
  "status": "success",
  "requestId": 166,
  "data": {
    "id": 2,
    "accountNumber": "80912570",
    "accountName": "John Smith",
    "iban": "GB36SRLG04000000000000",
    "sortCode": "040059",
    "bic": "SRXXXXXX",
    "country": "826",
    "directCreditEnabled": false,
    "directDebitEnabled": false,
    "inboundEnabled": false,
    "outboundEnabled": false,
    "providerName": "CENTROLINK",
    "requestReference": "123456789"
  }
}

Set automated payment status

URL Method
/api/v1/bank-account-address/automated-payment-status POST

Request

Parameter Type Length Required Description
bankAccountAddressId int 20 Yes BankAccountAddress->id.
directCreditEnabled bool 1 Yes BankAccountAddress->directCreditEnabled.
directDebitEnabled bool 1 Yes BankAccountAddress->directDebitEnabled.
{
    "bankAccountAddressId": 2,
    "directCreditEnabled": false,
    "directDebitEnabled": false
}

Response

Parameter Type Required Description
BankAccountAddress Yes Information about bank account address.
{
  "status": "success",
  "requestId": 164,
  "data": {
    "id": 2,
    "accountNumber": "80912570",
    "accountName": "John Smith",
    "iban": "GB36SRLG04000000000000",
    "sortCode": "040059",
    "bic": "SRXXXXXX",
    "country": "826",
    "directCreditEnabled": false,
    "directDebitEnabled": false,
    "inboundEnabled": false,
    "outboundEnabled": false
  }
}

Set payment status

URL Method
/api/v1/bank-account-address/payment-status POST

Request

Parameter Type Length Required Description
bankAccountAddressId int 20 Yes BankAccountAddress->id.
inboundEnabled bool 1 Yes BankAccountAddress->inboundEnabled.
outboundEnabled bool 1 Yes BankAccountAddress->inboundEnabled.
{
    "bankAccountAddressId": 2,
    "inboundEnabled": false,
    "outboundEnabled": false
}

Response

Parameter Type Required Description
BankAccountAddress Yes Information about bank account address.
{
  "status": "success",
  "requestId": 162,
  "data": {
    "id": 2,
    "accountNumber": "80912570",
    "accountName": "John Smith",
    "iban": "GB36SRLG04000000000000",
    "sortCode": "040059",
    "bic": "SRXXXXXX",
    "country": "826",
    "directCreditEnabled": false,
    "directDebitEnabled": false,
    "inboundEnabled": false,
    "outboundEnabled": false
  }
}

Direct debit

Bank account address

Create mandate

URL Method
/api/v1/mandate/create-bank-account-address-mandate POST
Request
Parameter Type Length Required Description
bankAccountAddressId int 20 Yes Bank account address identifier to which the mandate will be assigned to.
serviceUserNumber string 6 Yes Service usernumber of the mandate
reference string 18 Yes Mandate reference
requestReference string 25 Yes Request reference to track mandate creation
payerName string|null 18 No Name of the payer
originatorBankAccountAddress CreateMandateOriginatorBankAccountAddress Yes Originator account
mandateType string 255 Yes MandateType
{
    "bankAccountAddressId": 195,
    "serviceUserNumber": "111115",
    "reference": "REF312366123666",
    "payerName": "JRJONAS",
    "originatorBankAccountAddress": {
        "iban": null,
        "sortCode": "040000",
        "accountNumber": "00000001"
    },
    "mandateType": "PAPER"
}
Response
{
    "status": "success",
    "requestId": 114,
    "data": []
}

Amend mandate

URL Method
/api/v1/mandate/amend-bank-account-address-mandate POST
Request
Parameter Type Length Required Description
mandateId int 20 Yes Mandate identifier
reason string 255 Yes Mandate amendment reason
payeeBankAccountAddress string 34 Yes IBAN of the payee
{
    "mandateId": 81,
    "reason": "ACCOUNT_TRANSFERED",
    "payeeBankAccountAddress": "GB61CLRB04047212457831"
}
Response
{
    "status": "success",
    "requestId": 115,
    "data": []
}

Reject mandate

URL Method
/api/v1/mandate/reject-bank-account-address-mandate POST
Request
Parameter Type Length Required Description
mandateId int 20 Yes Mandate identifier
reason string 255 Yes Mandate rejection reason
{
    "mandateId": 81,
    "reason": "PAYER_DECEASED"
}
Response
{
    "status": "success",
    "requestId": 115,
    "data": []
}

Cancel mandate

URL Method
/api/v1/mandate/cancel-bank-account-address-mandate POST
Request
Parameter Type Length Required Description
mandateId int 20 Yes Mandate identifier
reason string 255 Yes Mandate cancellation reasons
{
    "mandateId": 77,
    "reason": "ACCOUNT_CLOSED"
}
Response
{
    "status": "success",
    "requestId": 174,
    "data": {}
}

Get mandates

URL Method
/api/v1/mandate/get-bank-account-address-mandates POST
Request
Parameter Type Length Required Description
bankAccountAddressId int 20 Yes Bank account address identifier
paginator Paginator No Request page information.
{
    "bankAccountAddressId": 182,
    "paginator": {
        "page": 1,
        "limit": 10
    }
}
Response
Parameter Type Length Required Description
paginator Paginator Yes Request page information.
mandates Mandate[] Yes Mandates array
{
    "status": "success",
    "requestId": 120,
    "data": {
        "paginator": {
            "limit": 1,
            "page": 1,
            "pagesCount": 15
        },
        "mandates": [
            {
                "id": 46,
                "originator": {
                    "id": 15,
                    "name": "TESTORIGINATOR",
                    "serviceUserNumber": "111115"
                },
                "status": "ACTIVE",
                "type": "PAPER",
                "reference": "1579012874"
            }
        ]
    }
}

Set upcoming payment status

URL Method
/api/v1/mandate/change-direct-debit-status POST

Request

Parameter Type Length Required Description
transactionId int 20 Yes
shouldPay bool 1 Yes
reason string 255 Yes ReturnReasons
{
    "transactionId": 90,
    "shouldPay": false,
    "reason": "ACCOUNT_CLOSED"
}

Response

Success
{
  "status": "success",
  "requestId": 172,
  "data": {
    "success": true
  }
}
Error
{
  "status": "error",
  "requestId": 173,
  "errors": [
    {
      "code": 12,
      "message": "Only pending direct debit transaction status can be updated.",
      "propertyPath": null
    }
  ]
}

Payment

Create outbound

URL Method
/api/v1/bank-transfer/outbound POST

Request

Parameter Type Length Required Description
scheme string 255 Yes Schemes. Multiple schemes can be provided as fallback schemes (seperated by comma). Supported schemes depend on bank provider.
sourceBankAccountAddressId int 20 Yes OutboundTransfer->sourceBankAccountAddressId.
destinationBankAccountAddress.accountName string 40 Yes OutboundTransfer->destination BankAccountAddress->accountName. Must contain at least two words separated by space for some providers.
destinationBankAccountAddress.accountNumber string 26 Conditional OutboundTransfer->destination BankAccountAddress->accountNumber.
Required if BankAccountAddress->iban is missing
destinationBankAccountAddress.sortCode string 6 Conditional OutboundTransfer->destination BankAccountAddress->sortCode.
Required if BankAccountAddress->iban is missing
destinationBankAccountAddress.iban string 34 Conditional OutboundTransfer->destination BankAccountAddress->iban.
Required if BankAccountAddress->accountNumber and BankAccountAddress->sortCode is missing.
destinationBankAccountAddress.type BeneficiaryTypes 255 Conditional Required for some bank providers.
currencyAndAmount CurrencyAndAmount Yes OutboundTransfer->CurrencyAndAmount
reference string 18 Conditional OutboundTransfer->reference.
In some cases, it may be required.
requestReference string 255 No OutboundTransfer->requestReference.
destinationDetails DestinationDetails Conditional Required for some bank providers.
{
    "scheme": "SCTI,SCT",
    "sourceBankAccountAddressId": "51",
    "destinationBankAccountAddress": {
        "iban": "GB36SRLG04000000000001",
        "accountName": "testing"
    },
    "currencyAndAmount": {
        "currency":"978",
        "minorUnits":1255
    },
    "reference": "AB78542",
    "destinationDetails": {
        "address": "receiver address",
        "postal": "receiver postal",
        "city": "receiver city",
        "country": null,
        "note": "message for receiver",
        "purpose": null
    }
}

Response

Parameter Type Required Description
BankTransfer Yes Information about bank transfer.
{
    "status": "success",
    "requestId": 262,
    "data": {
        "id": 193,
        "settlementAmount": 1255,
        "settlementCurrency": "978",
        "instructedAmount": 1255,
        "instructedCurrency": "978",
        "destinationMandate": null,
        "sourceBankAccountAddress": {
            "id": 51,
            "accountName": "testing1",
            "accountNumber": "98327306",
            "iban": "GB36SRLG04000000000000",
            "sortCode": "040059",
            "bic": "SRXXXXXX",
            "country": "826"
        },
        "destinationBankAccountAddress": {
            "id": 52,
            "accountName": "testing",
            "accountNumber": "21762634",
            "iban": "GB36SRLG04000000000001",
            "sortCode": "040059",
            "bic": "SRXXXXXX",
            "country": "826"
        },
        "requestReference": "12345678",
        "createdAt": "2019-07-10T13:20:28+00:00",
        "type":"SINGLE_IMMEDIATE_PAYMENT",
        "scheme":"SCT"
    }
}

Return inbound

URL Method
/api/v1/bank-transfer/return-inbound POST

Request

Parameter Type Length Required Description
transactionId InboundTransfer Yes Information about inbound transfer.
requestReference string 18 No
reference string 255 Conditional Required for specific payment schemes.
reason string 255 Conditional Depending on payment scheme.

See ReturnReasons
{
    "transactionId": 6,
    "reference": "AB78542",
    "reason": null
}

Response

Parameter Type Required Description
BankTransfer Yes Information about bank transfer.
{
  "status": "success",
  "requestId": 170,
  "data": {
    "id": 47,
    "settlementAmount": 1255,
    "settlementCurrency": "826",
    "instructedAmount": 1255,
    "instructedCurrency": "826",
    "sourceBankAccountAddress": {
      "id": 6,
      "accountNumber": "26304531",
      "iban": null,
      "sortCode": "040059",
      "country": "826",
      "bic": null
    },
    "destinationBankAccountAddress": {
      "id": 3,
      "accountNumber": "00004588",
      "iban": null,
      "sortCode": "203002",
      "country": "826",
      "bic": null
    },
    "createdAt": "2019-02-22T13:07:01+00:00"
  }
}

Return tranfer

URL Method
/api/v1/bank-transfer/return-transfer POST

Request

Parameter Type Length Required Description
transactionId int 20 Yes Idnetifier of the transfer.
requestReference string 18 No
reference string 255 Conditional Required for specific payment schemes.
reason string 255 Conditional See ReturnReasons
{
    "transactionId": 6,
    "requestReference": "REQREF123456951F",
    "reference": "AB78542",
    "reason": null
}

Response

Parameter Type Required Description
BankTransfer No Return transfer details (Returns nothing for Direct credit/debit transfers as transaction details are not known yet.
{
  "status": "success",
  "requestId": 170,
  "data": {
    "id": 47,
    "settlementAmount": 1255,
    "settlementCurrency": "826",
    "instructedAmount": 1255,
    "instructedCurrency": "826",
    "sourceBankAccountAddress": {
      "id": 6,
      "accountNumber": "26304531",
      "iban": null,
      "sortCode": "040059",
      "country": "826",
      "bic": null
    },
    "destinationBankAccountAddress": {
      "id": 3,
      "accountNumber": "00004588",
      "iban": null,
      "sortCode": "203002",
      "country": "826",
      "bic": null
    },
    "createdAt": "2019-02-22T13:07:01+00:00"
  }
}

Outbound cancel

URL Method
/api/v1/bank-transfer/outbound-cancel POST
Request
Parameter Type Length Required Description
transactionId int 20 Yes Information about outbound transfer.
reason string 255 Yes See Outbound cancel reasons
additionalInformation string 255 Conditional See Outbound cancel reasons which require this field.
reasonOriginatorName string 255 Conditional See Outbound cancel reasons which require this field.
{
  "transactionId": "244",
  "reason": "TECHNICAL_PROBLEM",
  "additionalInformation": null,
  "reasonOriginatorName": null
}
Response
{
  "status": "success",
  "requestId": 170,
  "data": {}
}

Transaction instruction

Inbound cancel

Approve

URL Method
/api/v1/bank-transfer/inbound-cancel-approve POST
Request
Parameter Type Length Required Description
cancelRequestId int 20 Yes Information about inbound transfer.
requestReference string 18 No
reason string 255 Yes For approve - send only 'FOLLOWING_CANCELATION_REQUEST'
{
    "cancelRequestId": 6,
    "reason": "FOLLOWING_CANCELATION_REQUEST"
}
Response
Parameter Type Required Description
BankTransfer Yes Information about bank transfer.
{
  "status": "success",
  "requestId": 170,
  "data": {
    "id": 47,
    "settlementAmount": 1255,
    "settlementCurrency": "826",
    "instructedAmount": 1255,
    "instructedCurrency": "826",
    "sourceBankAccountAddress": {
      "id": 6,
      "accountNumber": "26304531",
      "iban": null,
      "sortCode": "040059",
      "country": "826",
      "bic": null
    },
    "destinationBankAccountAddress": {
      "id": 3,
      "accountNumber": "00004588",
      "iban": null,
      "sortCode": "203002",
      "country": "826",
      "bic": null
    },
    "createdAt": "2019-02-22T13:07:01+00:00"
  }
}

Decline

URL Method
/api/v1/bank-transfer/inbound-cancel-decline POST
Request
Parameter Type Length Required Description
cancelRequestId int 20 Yes Information about inbound transfer.
requestReference string 18 No
reason string 255 Yes See Inbound Cancel request decline reasons
{
    "cancelRequestId": 6,
    "reason": "ACCOUNT_CLOSED"
}
Response
Parameter Type Required Description
TransactionInstruction Yes Information about transaction instruction.
{
  "status": "success",
  "requestId": 170,
  "data": {
    "id": 123,
    "type": "INBOUND_RESOLUTION_OF_INVESTIGATION",
    "status": "PENDING",
    "reasonCode": "ACCOUNT_CLOSED",
    "createdAt": "2019-10-10T15:11:48+00:00"
  }
}

Transaction

Bank account address

URL Method
/api/v1/transaction/bank-account-address POST

Request

Parameter Type Length Required Description
bankAccountAddressId int 20 No Bank account address id
transactionId int 20 No Search for specific transaction by its unique id
requestReference string 18 No Search tx by request reference of transaction
instructionRequestReference string 18 No Search tx by request reference of instruction
direction string 8 No See BankTransferDirections
type string 255 No See BankTransferTypes
dateFrom string 19 No From search date
dateTo string 19 No To search date
paginator Paginator No Request page information.
{
    "bankAccountAddressId": "48",
    "direction": "ALL",
    "type": "DIRECT_CREDIT_PAYMENT",
    "dateFrom": "2019-04-18 13:34:30",
    "dateTo": "2019-07-11 08:27:19",
    "paginator": {
        "page": 1,
        "limit": 30
    }
}

Response

Parameter Type Required Description
paginator Paginator Yes Request page information.
transactions BankTransfer Yes Current page of transfers.
{
    "status": "success",
    "requestId": 314,
    "data": {
        "paginator": {
            "limit": 30,
            "page": 1,
            "pagesCount": 1
        },
        "transactions": [
            {
                "id": 166,
                "settlementAmount": 100,
                "settlementCurrency": "826",
                "instructedAmount": 100,
                "instructedCurrency": "826",
                "sourceMandateOriginator":{
                    "id":1,
                    "name":"SUSPENSE ",
                    "serviceUserNumber":"402927"
                },
                "destinationMandate": null,
                "sourceBankAccountAddress": {
                    "id": 48,
                    "accountName": "dsfgsfsdf TEST",
                    "accountNumber": "62201870",
                    "iban": "GB36SRLG04000000000000",
                    "sortCode": "040059",
                    "bic": "SRXXXXXX",
                    "country": "826"
                },
                "destinationBankAccountAddress": {
                    "id": 49,
                    "accountName": "sdfsdf",
                    "accountNumber": "71395713",
                    "iban": "GB36SRLG04000000000001",
                    "sortCode": "555712",
                    "bic": null,
                    "country": "440"
                },
                "requestReference": 1234567899,
                "reference": "T45785687",
                "transactionIdentifier": "TX123456789",
                "endToEndIdentifier": "12345678910",
                "createdAt": "2019-07-09T07:16:13+00:00",
                "updatedAt": "2019-07-09T07:21:07+00:00",
                "direction": "OUTBOUND",
                "status": "ACCEPTED",
                "returnDetails": null,
                "details": {
                    "senderData": {
                      "name": "Money Sender Comp.",
                      "iban": "GB36SRLG04005932936187",
                      "country": "826",
                      "addressLineOne": "67889 ST MARY",
                      "addressLineTwo": "London"
                    },
                    "receiverData": {
                      "name": "Money Receiver Comp.",
                      "iban": "GB79SRLG04005938089896",
                      "country": null,
                      "addressLineOne": null,
                      "addressLineTwo": null
                    },
                    "note": "Intern Company note",
                    "purpose": "1234"
                 },
                "type": "SINGLE_IMMEDIATE_PAYMENT"
            },
            {
                "id": 167,
                "settlementAmount": 100,
                "settlementCurrency": "826",
                "instructedAmount": 100,
                "instructedCurrency": "826",
                "destinationMandate": null,
                "sourceBankAccountAddress": {
                    "id": 48,
                    "accountName": "dsfgsfsdf TEST",
                    "accountNumber": "62201870",
                    "iban": "GB36SRLG04000000000000",
                    "sortCode": "040059",
                    "bic": "SRXXXXXX",
                    "country": "826"
                },
                "destinationBankAccountAddress": {
                    "id": 49,
                    "accountName": "sdfsdf",
                    "accountNumber": "71395713",
                    "iban": "GB36SRLG04000000000001",
                    "sortCode": "555712",
                    "bic": null,
                    "country": "440"
                },
                "requestReference": 123456789,
                "transactionIdentifier": "TX123456789",
                "endToEndIdentifier": "12345678910",
                "reference": "T45785687",
                "createdAt": "2019-07-09T07:21:07+00:00",
                "updatedAt": "2019-07-09T07:21:07+00:00",
                "direction": "OUTBOUND",
                "status": "ACCEPTED",
                "returnDetails": null,
                "type": "SINGLE_IMMEDIATE_PAYMENT"
            }
        ]
    }
}

Exchange

Quote

Returns an expected exchange rate and bought/sold currency amount for provided details.

URL Method
/api/v1/exchange/quote POST

Request

Parameter Type Length Required Description
sourceBankAccountAddressId int 20 Yes
goal int 20 Yes Goal amount of currency to sell/buy.
goalType string 20 Yes See ExchangeTypes
sourceCurrencyIson string 3 Yes
targetCurrencyIson string 3 Yes
{
    "sourceBankAccountAddressId": 173150,
    "goal": 500,
    "goalType": "BUY",
    "sourceCurrencyIson": 978,
    "targetCurrencyIson": 826
}

Response

Parameter Type Length Required Description
sourceAmount int 20 Yes
targetAmount int 20 Yes
sourceCurrencyIson string 3 Yes
targetCurrencyIson string 3 Yes
exchangeRate string 255 Yes Expected exchange rate.
fees ExchangeQuoteFee[] Yes
timeStamp string 19 Yes Exchange rate checked at time.
{
    "status": "success",
    "requestId": 618395913683063641,
    "data": {
        "sourceAmount": 578,
        "targetAmount": 500,
        "sourceCurrencyIson": "978",
        "targetCurrencyIson": "826",
        "exchangeRate": "0.86805556",
        "fees": [
            {
                "percentage": "0.0020040080160321",
                "amount": 2,
                "currencyIson": "978"
            }
        ],
        "timeStamp": "2021-04-14T10:25:13+00:00"
    }
}

Create

Creates a new currency exchange.

URL Method
/api/v1/exchange/create POST

Request

Parameter Type Length Required Description
sourceBankAccountAddressId int 20 Yes
goal int 20 Yes Goal amount of currency to sell/buy.
goalType string 20 Yes See ExchangeTypes
sourceCurrencyIson string 3 Yes
targetCurrencyIson string 3 Yes
requestReference string 255 Yes Required 10-255 symbols
useAvailableFunds bool No Defaults to true. If false is provided, allocation has to be done via Allocate API call.
{
    "sourceBankAccountAddressId": 173150,
    "goal": 200,
    "goalType": "SELL",
    "sourceCurrencyIson": 978,
    "targetCurrencyIson": 826,
    "requestReference": "A00000000026",
    "useAvailableFunds": true
}

Response

Parameter Type Length Required Description
data Exchange Yes
{
    "status": "success",
    "requestId": 618559505293462401,
    "data": {
        "id": 1,
        "sourceBankAccountAddress": {
            "id": 6,
            "ownerName": "testaccount",
            "accountName": "testaccount",
            "accountNumber": "F36462860",
            "country": "826"
        },
        "goalAmount": 500,
        "boughtAmount": 423,
        "soldAmount": 499,
        "sourceCurrency": "978",
        "targetCurrency": "826",
        "requestReference": "A00000000032",
        "transactions": [],
        "goalType": "SELL",
        "status": "PENDING"
    }
}

Allocate

Allocates money for currency exchange, if exchange was created with: useAvailableFunds = false

URL Method
/api/v1/exchange/allocate POST

Request

Parameter Type Length Required Description
exchangeId int 20 Yes
{
    "exchangeId": 1
}

Response

{
    "status": "success",
    "requestId": 901,
    "data": []
}

Approve

Exchange 4 eye principle - in case exchange is created in GUI, it will need to be approved/rejected in API, or vice versa (if the principle is used).

URL Method
/api/v1/exchange/approve POST

Request

Parameter Type Length Required Description
exchangeId int 20 Yes
{
    "exchangeId": 1
}

Response

{
    "status": "success",
    "requestId": 901,
    "data": []
}

Cancel

Straight up cancel's the exchange.

URL Method
/api/v1/exchange/cancel POST

Request

Parameter Type Length Required Description
exchangeId int 20 Yes
{
    "exchangeId": 1
}

Response

{
    "status": "success",
    "requestId": 901,
    "data": []
}

Reject

Exchange 4 eye principle - in case exchange is created in GUI, it will need to be approved/rejected in API, or vice versa (if the principle is used).

URL Method
/api/v1/exchange/reject POST

Request

Parameter Type Length Required Description
exchangeId int 20 Yes
{
    "exchangeId": 1
}

Response

{
    "status": "success",
    "requestId": 901,
    "data": []
}

Webhook

Resend latest transfer webhook

URL Method
/api/v1/webhook/resend-latest-transfer-webhook POST

Request

Parameter Type Length Required Description
transactionId int 20 Conditional Required if RequestReference is not provided.
requestReference string 18 Conditional Required if TransactionId is not provided.
{
    "transactionId": null,
    "requestReference": "MyRequestReference"
}

Response

{
    "status": "success",
    "requestId": 901,
    "data": []
}

Webhooks

Bank account address

Created

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/bank-account-address-created POST

Request

Parameter Type Length Description
id int 20
accountNumber string | null 26
accountName string | null 255
iban string 34
sortCode string | null 6
bic string 12
currency string 3 Currency ISON.
directCreditEnabled bool 1
directDebitEnabled bool 1
inboundEnabled bool 1
outboundEnabled bool 1
providerName string 50 See BankProviders
Example
{  
   "id":7,
   "accountName":"testName",
   "accountNumber":"46330846",
   "iban":"GB36SRLG04000000000000",
   "sortCode":"040059",
   "bic":"SRXXXXXX",
   "currency":"826",
   "directCreditEnabled": false,
   "directDebitEnabled": false,
   "inboundEnabled": false,
   "outboundEnabled": false,
   "providerName": "CENTROLINK"
}

Status changed

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/bank-account-address-status-change POST

Request

Parameter Type Length Description
bankAccountAddressId int 20
inboundEnabled bool 1
outboundEnabled bool 1
Example
{  
   "bankAccountAddressId":20,
   "inboundEnabled":false,
   "outboundEnabled":true
}

Details changed

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/bank-account-address-details-changed POST

Request

Parameter Type Length Description
bankAccountAddressId int 20
accountName string 255
Example
{  
   "bankAccountAddressId": 20,
   "accountName": "John Doe"
}

Direct credit

Received

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-credit-received POST

Request

Parameter Type Length Description
id int 20
settlementAmount int 20
settlementCurrency string 3 Currency ISON.
status string 255 See BankTransferStatuses
scheme string 255 See BankTransferSchemes
sourceMandateOriginator MandateOriginator | null -
destinationBankAccountAddress BankAccountAddress -
reference string 255 Optional
endToEndIdentifier string 255
transactionIdentifier string 255 Optional
Example
{
  "id": 97,
  "settlementAmount": 131200,
  "settlementCurrency": "826",
  "sourceMandateOriginator": {
    "id": 8,
    "name": "OEHWqHFRFMqvVkFGBf",
    "serviceUserNumber": "336722"
  },
  "destinationBankAccountAddress": {
    "id": 7,
    "accountName": "testName",
    "accountNumber": "46330846",
    "iban": "GB36SRLG04000000000000",
    "sortCode": "040059",
    "bic": "SRXXXXXX"
  },
  "reference": "asdfasdf",
  "scheme": "FPS",
  "status": "ACCEPTED",
  "endToEndIdentifier": "12345678910",
  "transactionIdentifier": "TX123456789"
}

Paid

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-credit-paid POST

Request

Parameter Type Description
updatedAt datetime
transaction BankTransfer
Example
{
    "updatedAt": "2020-07-03T08:10:04+00:00",
    "transaction": {
        "id": 159,
        "settlementAmount": 555,
        "settlementCurrency": "826",
        "instructedAmount": 555,
        "instructedCurrency": "826",
        "sourceMandateOriginator": {
            "id": 111,
            "name": "TEST",
            "serviceUserNumber": "758170"
        },
        "sourceBankAccountAddress": {
            "id": 555,
            "ownerName": "TEST",
            "accountName": "TEST",
            "iban": "GB36SRLG04000000000000",
            "bban": "SRLG04000000000000",
            "country": "826"
        },
        "destinationBankAccountAddress": {
            "id": 41769,
            "ownerName": "test",
            "accountName": "test",
            "accountNumber": "00003525",
            "iban": "GB36XXXX00000000000000",
            "sortCode": "000000",
            "bic": "XXXXGB22",
            "country": "826"
        },
        "details": {
            "note": "CRED RUN",
            "senderData": {
                "name": "COUNTRYSIDE ALLIAN",
                "iban": null,
                "bban": "SRLG04000000000000",
                "bic": null,
                "country": null,
                "addressLineOne": null,
                "addressLineTwo": null
            },
            "receiverData": {
                "name": "test",
                "iban": "GB36XXXX00000000000000",
                "bban": "XXXX00000000000000",
                "bic": null,
                "country": null,
                "addressLineOne": null,
                "addressLineTwo": null
            }
        },
        "createdAt": "2020-07-03T08:09:59+00:00",
        "direction": "INBOUND",
        "status": "ACCEPTED",
        "type": "DIRECT_CREDIT_PAYMENT",
        "scheme": "BACS"
    }
}

Direct debit

Due

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-due POST

Request

Parameter Type Length Description
dueAt date 10
directDebitTx DirectDebitTransaction
Example
{  
   "dueAt":"2019-03-27",
   "directDebitTx":{  
        "id":93,
        "settlementAmount":12300,
        "settlementCurrency":"826",
        "instructedAmount":12300,
        "instructedCurrency":"826",
        "destinationMandate":{  
           "id":3,
           "originator":{  
              "id":1,
              "name":"ANTIQUARIES",
              "serviceUserNumber":"123456"
           },
           "reference": "R0VxdS9Xa1NDa0FSRGUydlVvSUxkQT09",
           "status": "ACTIVE",
           "type": "ORIGINATION"
        },
        "sourceBankAccountAddress":{  
           "id":7,
           "accountName":"John Smith",
           "accountNumber":"46330846",
           "iban":"GB36SRLG04000000000000",
           "sortCode":"040059",
           "country": "826",
           "bic":"SRXXXXXX"
        },
        "details": {
           "debitType":"FIRST"
        },
        "scheme": "SDD",
        "direction": "OUTBOUND",
        "status": "PENDING",
        "type": "DIRECT_DEBIT_PAYMENT",
        "createdAt":"2019-03-27T09:34:01+00:00"
   }
}

Paid

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-paid POST

Request

Parameter Type Description
directDebitTx DirectDebitTransaction
Example
{  
   "directDebitTx":{  
        "id":93,
        "settlementAmount":12300,
        "settlementCurrency":"826",
        "instructedAmount":12300,
        "instructedCurrency":"826",
        "destinationMandate":{  
           "id":3,
           "originator":{  
              "id":1,
              "name":"ANTIQUARIES",
              "serviceUserNumber":"123456"
           },
          "reference": "R0VxdS9Xa1NDa0FSRGUydlVvSUxkQT09",
          "status": "ACTIVE",
          "type": "ORIGINATION"
        },
        "sourceBankAccountAddress":{  
           "id":7,
           "accountName":"John Smith",
           "accountNumber":"46330846",
           "iban":"GB36SRLG04000000000000",
           "sortCode":"040059",
           "country": "826",
           "bic":"SRXXXXXX"
        },
        "details": {
           "debitType":"FIRST"
        },
        "scheme": "SDD",
        "direction": "OUTBOUND",
        "status": "ACCEPTED",
        "type": "DIRECT_DEBIT_PAYMENT",
        "createdAt":"2019-03-27T09:34:01+00:00"
   }
}

Rejected

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-rejected POST

Request

Parameter Type Description
directDebitTx DirectDebitTransaction
Example
{  
   "directDebitTx":{  
        "id":93,
        "settlementAmount":12300,
        "settlementCurrency":"826",
        "instructedAmount":12300,
        "instructedCurrency":"826",
        "destinationMandate":{  
           "id":3,
           "originator":{  
              "id":1,
              "name":"ANTIQUARIES",
              "serviceUserNumber":"123456"
           },
           "reference": "R0VxdS9Xa1NDa0FSRGUydlVvSUxkQT09",
           "status": "ACTIVE",
           "type": "ORIGINATION"
        },
        "sourceBankAccountAddress":{  
           "id":7,
           "accountName":"John Smith",
           "accountNumber":"46330846",
           "iban":"GB36SRLG04000000000000",
           "sortCode":"040059",
           "country": "826",
           "bic":"SRXXXXXX"
        },
        "details": {
           "debitType":"FIRST"
        },
        "scheme": "SDD",
        "direction": "OUTBOUND",
        "status": "REJECTED",
        "type": "DIRECT_DEBIT_PAYMENT",
        "createdAt":"2019-03-27T09:34:01+00:00"
   }
}

Direct debit mandate

Canceled

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-mandate-canceled POST

Request

Parameter Type Length Description
mandateId int 20 Mandate identifier that points to the mandate that got Cancelled
mandate Mandate Mandate data
requestReference string 255 Request reference
canceledAt datetime 25 Date and time on when the mandate was Cancelled
Example
{  
   "mandateId":2,
   "mandate": {
      "id": 2,
      "originator": {
         "id": 3,
         "name": "Originator",
         "serviceUserNumber": "423d1518-09cd-48cd-aeaa-fc532468b957"
      },
      "reference": "NFlndGR1R2pNOXlXSk1yL2NRajhnQT09",
      "status": "CANCELED",
      "type": "ORIGINATION"
   },
   "requestReference": "MDU123456789",
   "canceledAt":"2019-03-27T08:53:53+00:00"
}

Cancelation failed

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-mandate-cancelation-failed POST

Request

Parameter Type Length Description
mandateId int 20 Mandate identifier
mandate Mandate Mandate data
requestReference string 255 Request reference
failedAt datetime 25 Date and time on when the cancellation failed
Example
{  
   "mandateId":2,
   "mandate": {
      "id": 2,
      "originator": {
         "id": 3,
         "name": "Originator",
         "serviceUserNumber": "423d1518-09cd-48cd-aeaa-fc532468b957"
      },
      "reference": "NFlndGR1R2pNOXlXSk1yL2NRajhnQT09",
      "status": "ACTIVE",
      "type": "ORIGINATION"
   },
   "requestReference": "MDU123456789",
   "failedAt":"2019-03-27T08:53:53+00:00"
}

Return failed

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-mandate-return-failed POST

Request

Parameter Type Length Description
mandateId int 20 Mandate identifier
mandate Mandate Mandate data
requestReference string 255 Request reference
failedAt datetime 25 Date and time on when the return failed
Example
{  
   "mandateId":2,
   "mandate": {
      "id": 2,
      "originator": {
         "id": 3,
         "name": "Originator",
         "serviceUserNumber": "423d1518-09cd-48cd-aeaa-fc532468b957"
      },
      "reference": "NFlndGR1R2pNOXlXSk1yL2NRajhnQT09",
      "status": "ACTIVE",
      "type": "ORIGINATION"
   },
   "requestReference": "MDU123456789",
   "failedAt":"2019-03-27T08:53:53+00:00"
}

Activated

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-mandate-activated POST

Request

Parameter Type Length Description
mandateId int 20 Mandate identifier that points to the mandate that got Activated.
mandate Mandate Mandate data
requestReference string 255 Request reference
activatedAt datetime 25 Date and time on when the mandate was Activated.
Example
{  
   "mandateId":2,
   "mandate": {
      "id": 2,
      "originator": {
         "id": 3,
         "name": "Originator",
         "serviceUserNumber": "423d1518-09cd-48cd-aeaa-fc532468b957"
      },
      "reference": "NFlndGR1R2pNOXlXSk1yL2NRajhnQT09",
      "status": "ACTIVE",
      "type": "ORIGINATION"
   },
   "requestReference": "MDU123456789",
   "activatedAt":"2019-03-27T08:53:53+00:00"
}

Activation failed

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-mandate-activation-failed POST

Request

Parameter Type Length Description
mandateId int 20 Mandate identifier that points to the mandate that Activation Failed.
mandate Mandate Mandate data
requestReference string 255 Request reference
failedAt datetime 25 Date and time on when the mandate was Activation Failed.
Example
{  
   "mandateId":2,
   "mandate": {
      "id": 2,
      "originator": {
         "id": 3,
         "name": "Originator",
         "serviceUserNumber": "423d1518-09cd-48cd-aeaa-fc532468b957"
      },
      "reference": "NFlndGR1R2pNOXlXSk1yL2NRajhnQT09",
      "status": "PENDING",
      "type": "ORIGINATION"
   },
   "requestReference": "MDU123456789",
   "failedAt":"2019-03-27T08:53:53+00:00"
}

Migrated

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-mandate-migrated POST

Request

Parameter Type Length Description
mandateId int 20 Identifier to find the migrated mandate
mandate Mandate Mandate data
requestReference string 255 Request reference
oldType string 255 MandateType
newType string 255 MandateType
migratedAt datetime 25 Date and time of mandate migration
Example
{  
   "mandateId":2,
   "mandate": {
      "id": 2,
      "originator": {
         "id": 3,
         "name": "Originator",
         "serviceUserNumber": "423d1518-09cd-48cd-aeaa-fc532468b957"
      },
      "reference": "NFlndGR1R2pNOXlXSk1yL2NRajhnQT09",
      "status": "ACTIVE",
      "type": "ORIGINATION"
   },
   "requestReference": "MDU123456789",
   "oldType": "PAPER",
   "newType": "MIGRATED",
   "migratedAt":"2019-03-27T08:53:53+00:00"
}

Finished

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-mandate-finished POST

Request

Parameter Type Length Description
mandateId int 11 Mandate identifier that points to the mandate that got Finished
mandate Mandate Mandate data
requestReference string 255 Request reference
finishedAt datetime 25 Date and time on when the mandate was Finished
Example
{  
   "mandateId":2,
   "mandate": {
      "id": 2,
      "originator": {
         "id": 3,
         "name": "Originator",
         "serviceUserNumber": "423d1518-09cd-48cd-aeaa-fc532468b957"
      },
      "reference": "NFlndGR1R2pNOXlXSk1yL2NRajhnQT09",
      "status": "FINISHED",
      "type": "ORIGINATION"
   },
   "requestReference": "MDU123456789",
   "finishedAt":"2019-03-27T08:53:53+00:00"
}

Created

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-mandate-created POST

Request

Parameter Type Length Description
mandateId int 11 Newly created mandate identifier
type MandateType
status MandateStatus
bankAccountAddressId string 11 Bank account address identifier to which the mandate is assigned to
originator MandateOriginator Mandate originator details
originatorBankAccountAddress MandateOriginatorBankAccountAddress Mandate originator account details
reference string 35 Mandate reference
requestReference string 255 Request reference
createdAt datetime 25 Mandate creation date
Example
{  
    "mandateId":2,
    "type": "PAPER",
    "status": "PENDING",
    "bankAccountAddressId":7,
    "originator":{
        "id":1,
        "name":"Test",
        "serviceUserNumber":"123456"
    },
    "originatorBankAccountAddress": {
        "id": 57406,
        "ownerName": "Test",
        "accountName": "Test",
        "accountNumber": "00001582",
        "sortCode": "041334",
        "country": "826"
    },
    "reference":"AB78542",
    "requestReference": "MDU123456789",
    "createdAt":"2019-03-27T08:53:53+00:00"
}

Originator changed

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/direct-debit-mandate-originator-changed POST

Request

Parameter Type Length Description
mandateId int 20
mandate Mandate Mandate data
requestReference string 255 Request reference
oldOriginator MandateOriginator
newOriginator MandateOriginator
Example
{  
   "mandateId":2,
   "mandate": {
      "id": 2,
      "originator": {
         "id": 7,
         "name": "TEST",
         "serviceUserNumber": "123466"
      },
      "reference": "NFlndGR1R2pNOXlXSk1yL2NRajhnQT09",
      "status": "ACTIVE",
      "type": "ORIGINATION"
   },
   "requestReference": "MDU123456789",
   "oldOriginator":{  
      "id":1,
      "name":"ANTIQUARIES",
      "serviceUserNumber":"123456"
   },
   "newOriginator":{  
      "id":7,
      "name":"TEST",
      "serviceUserNumber":"123466"
   }
}

Payment

Inbound

Held

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-inbound-held POST
Request
Parameter Type Length Description
inboundTransactionId int 20
updatedAt datetime 25
transaction BankTransfer
Example
{
    "inboundTransactionId": 2,
    "updatedAt": "2019-03-08T08:45:07+00:00",
    "transaction": { 
        "id": 2,
        "settlementAmount":1255,
        "settlementCurrency":"826",
        "instructedAmount":1255,
        "instructedCurrency":"826",
        "sourceBankAccountAddress": {  
            "id":1,
            "iban":"GB36SRLG04000000000000",
            "accountNumber":"32936187",
            "sortCode":"040059",
            "country": "826",
            "bic":"SRXXXXXX"
        },
        "destinationBankAccountAddress": {  
            "id":2,
            "iban":"GB36SRLG04000000000001",
            "accountNumber":"38089896",
            "sortCode":"040059",
            "country": "826",
            "bic":"SRXXXXXX"
        },
        "details": {
          "senderData": {
            "name": "Money Sender Comp.",
            "iban": "GB36SRLG04000000000000",
            "country": "826",
            "addressLineOne": "67889 ST MARY",
            "addressLineTwo": "London"
          },
          "receiverData": {
            "name": "Money Receiver Comp.",
            "iban": "GB36SRLG04000000000001",
            "country": null,
            "addressLineOne": null,
            "addressLineTwo": null
          },
          "note": "Intern Company note",
          "purpose": "1234"
        },
        "reference":"AB12345",
        "createdAt":"2019-03-08T08:43:07+00:00",
        "type": "SINGLE_IMMEDIATE_PAYMENT",
        "scheme": "SCT"
    }
}

Received

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-inbound-received POST
Request
Parameter Type Length Description
id int 20
settlementAmount int 20
settlementCurrency string 3 Currency ISON.
instructedAmount int 20
instructedCurrency string 3 Currency ISON.
exchange int | null 20 Available for Exchange related transactions
status string 8 See BankTransferStatuses
scheme string 255 See BankTransferSchemes
type string 255 See BankTransferTypes
createdAt datetime 25
sourceBankAccountAddress BankAccountAddress | null Sometimes may be null for imported transactions (depends on bank provider)
destinationBankAccountAddress BankAccountAddress
reference string| null 255
transactionIdentifier string| null 100
endToEndIdentifier string| null 100
details TransactionDetails
Example
{  
   "id":23,
   "settlementAmount":1255,
   "settlementCurrency":"826",
   "instructedAmount":1255,
   "instructedCurrency":"826",
   "sourceBankAccountAddress":{  
      "id":1,
      "accountNumber":"32936187",
      "iban":"GB36SRLG04000000000000",
      "bban": "SRLG04005932936187",
      "sortCode":"040059",
      "country": "826",
      "bic":"SRXXXXXX"
   },
   "destinationBankAccountAddress":{  
      "id":2,
      "accountNumber":"38089896",
      "iban":"GB36SRLG04000000000001",
      "bban":"SRLG04005938089896",
      "sortCode":"040059",
      "country": "826",
      "bic":"SRXXXXXX"
   },
   "status":"ACCEPTED",
   "scheme":"TRANSFER",
   "type":"SINGLE_IMMEDIATE_PAYMENT",
   "createdAt":"2019-03-08T08:43:07+00:00",
   "reference":"AB78542",
   "details": {
     "senderData": {
       "name": "Money Sender Comp.",
       "iban": "GB36SRLG04000000000000",
       "country": "826",
       "addressLineOne": "67889 ST MARY",
       "addressLineTwo": "London"
     },
     "receiverData": {
       "name": "Money Receiver Comp.",
       "iban": "GB36SRLG04000000000001",
       "country": null,
       "addressLineOne": null,
       "addressLineTwo": null
     },
     "note": "Intern Company note",
     "purpose": "1234"
   }
}

Reversed

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-inbound-reversed POST
Request
Parameter Type Length Description
reversedTransactionId int 20
reasonDescription string 255
Example
{  
   "reversedTransactionId":19,
   "reasonDescription":"Request Timed out"
}

Return created

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-inbound-return-created POST
Request
Parameter Type Description
InboundReturnTransfer Information about inbound return transfer
Example
{
  "id": 145,
  "returnedTransactionId": 139,
  "settlementAmount": 10000,
  "settlementCurrency": "978",
  "instructedAmount": 10000,
  "instructedCurrency": "978",
  "sourceBankAccountAddress": {
    "id": 1,
    "accountNumber": "32936187",
    "iban": "GB36SRLG04000000000000",
    "sortCode": "040059",
    "country": "826",
    "bic": "SRXXXXXX"
  },
  "destinationBankAccountAddress": {
    "id": 2,
    "accountNumber": "38089896",
    "iban": "GB36SRLG04000000000001",
    "sortCode": "040059",
    "country": "826",
    "bic": "SRXXXXXX"
  },
  "status": "PENDING",
  "type": "INBOUND_PAYMENT_RETURN",
  "scheme": "SCT",
  "reference": "123456789abcdefgxasdwqx88897",
  "reasonCode": "FOLLOWING_CANCELATION_REQUEST",
  "createdAt": "2019-12-09T11:45:41+00:00"
}

Return updated

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-inbound-return-updated POST
Request
Parameter Type Length Description
transactionId int 20
returnedTransactionId int 20
transaction BankTransfer
requestReference string | null 255
type string 255 INBOUND_PAYMENT_RETURN
status string 8 See BankTransferStatuses
scheme string 255 See BankTransferSchemes
updatedAt datetime 25
Example
{
  "transactionId": 145,
  "returnedTransactionId": "139",
  "transaction":{  
    "id":2,
    "requestReference": "MY-TX-REF-0000000002",
    "settlementAmount":1255,
    "settlementCurrency":"826",
    "instructedAmount":1255,
    "instructedCurrency":"826",
    "sourceBankAccountAddress":{  
       "id":1,
       "accountNumber":"32936187",
       "iban":"GB36SRLG04000000000000",
       "sortCode":"040059",
       "country": "826",
       "bic":"SRXXXXXX"
    },
    "destinationBankAccountAddress":{  
       "id":2,
       "accountNumber":"38089896",
       "iban":"GB36SRLG04000000000001",
       "sortCode":"040059",
       "country": "826",
       "bic":"SRXXXXXX"
    },
    "createdAt":"2019-03-08T08:43:07+00:00"
  },
  "type": "INBOUND_PAYMENT_RETURN",
  "status": "ACCEPTED",
  "scheme": "TRANSFER",
  "updatedAt": "2019-12-06T08:53:43+00:00"
}

Outbound

Created

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-outbound-created POST
Request
Parameter Type Description
transaction BankTransfer
Example
{
    "transaction": {
        "id": 791,
        "settlementAmount": 79212,
        "settlementCurrency": "826",
        "instructedAmount": 79212,
        "instructedCurrency": "826",
        "sourceBankAccountAddress": {
            "id": 254,
            "accountName": "asdadasdasd",
            "accountNumber": "00000009",
            "iban": "GB36SRLG04000000000000",
            "sortCode": "040059",
            "bic": "SRXXXXXX",
            "country": "826"
        },
        "destinationBankAccountAddress": {
            "id": 255,
            "accountName": " Test",
            "iban": "GB36SRLG04000000000001",
            "bban": "DEUT40508129256000",
            "country": "826"
        },
        "details": {
          "senderData": {
            "name": "Money Sender Comp.",
            "iban": "GB36SRLG04000000000000",
            "country": "826",
            "addressLineOne": "67889 ST MARY",
            "addressLineTwo": "London"
          },
          "receiverData": {
            "name": "Money Receiver Comp.",
            "iban": "GB36SRLG04000000000001",
            "country": "826",
            "addressLineOne": null,
            "addressLineTwo": null
          },
          "note": "Payment for flat rent.",
          "purpose": null
        },
        "createdAt": "2020-01-03T14:36:18+00:00",
        "direction": "OUTBOUND",
        "status": "ACCEPTED",
        "type": "SINGLE_IMMEDIATE_PAYMENT",
        "scheme":"SCT",
        "requestReference": "blablabla"
    }
}

Redirected

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-outbound-redirected POST
Request
Parameter Type Length Description
transactionId int 20
requestReference string | null 255
originalAccount BankAccountAddress
redirectedAccount BankAccountAddress
Example
{  
   "transactionId":23,
   "requestReference": "12345678",
   "originalAccount":{  
      "id":1,
      "accountNumber":"32936187",
      "iban":"GB36SRLG04000000000000",
      "sortCode":"040059",
      "country": "826",
      "bic":"SRXXXXXX"
   },
   "redirectedAccount":{  
      "id":2,
      "accountNumber":"38089896",
      "iban":"GB36SRLG04000000000001",
      "sortCode":"040059",
      "country": "826",
      "bic":"SRXXXXXX"
   }
}

Returned

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-outbound-returned POST
Request
Parameter Type Length Description
returnedTransactionId int 20
returnedTransactionRequestReference string | null 255
returnTransaction BankTransfer
reasonCode string 255 See OutboundTransferReturnReasons
reasonDescription string 255
Example
{  
   "returnedTransactionId":1,
   "returnedTransactionRequestReference": "123456789",
   "returnTransaction":{  
      "id":2,
      "settlementAmount":1255,
      "settlementCurrency":"826",
      "instructedAmount":1255,
      "instructedCurrency":"826",
      "sourceBankAccountAddress":{  
         "id":1,
         "accountNumber":"32936187",
         "iban":"GB36SRLG04000000000000",
         "sortCode":"040059",
         "country": "826",
         "bic":"SRXXXXXX"
      },
      "destinationBankAccountAddress":{  
         "id":2,
         "accountNumber":"38089896",
         "iban":"GB36SRLG04000000000001",
         "sortCode":"040059",
         "country": "826",
         "bic":"SRXXXXXX"
      },
      "createdAt":"2019-03-08T08:43:07+00:00",
      "type":"SINGLE_IMMEDIATE_PAYMENT",
      "scheme":"SCT",
      "requestReference": "REQREF123456951F"
   },
   "reasonCode":"ACCOUNT_BLOCKED",
   "reasonDescription":"Account blocked"
}

Return created

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-outbound-return-created POST
Request
Parameter Type Length Description
returnedTransactionId int 20
returnedTransactionRequestReference string | null 255
returnTransaction BankTransfer
reasonCode string 255 See OutboundTransferReturnReasons
reasonDescription string 255
Example
{  
   "returnedTransactionId":1,
   "returnedTransactionRequestReference": "123456789",
   "returnTransaction":{  
      "id":2,
      "settlementAmount":1255,
      "settlementCurrency":"826",
      "instructedAmount":1255,
      "instructedCurrency":"826",
      "sourceBankAccountAddress":{  
         "id":1,
         "accountNumber":"32936187",
         "iban":"GB36SRLG04000000000000",
         "sortCode":"040059",
         "country": "826",
         "bic":"SRXXXXXX"
      },
      "destinationBankAccountAddress":{  
         "id":2,
         "accountNumber":"38089896",
         "iban":"GB36SRLG04000000000001",
         "sortCode":"040059",
         "country": "826",
         "bic":"SRXXXXXX"
      },
      "createdAt":"2019-03-08T08:43:07+00:00",
      "type":"SINGLE_IMMEDIATE_PAYMENT",
      "scheme":"SCT",
      "requestReference": "REQREF123456951F"
   },
   "reasonCode":"ACCOUNT_BLOCKED",
   "reasonDescription":"Account blocked"
}

Return rejected

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-outbound-return-rejected POST
Request
Parameter Type Length Description
returnedTransactionId int 20
returnedTransactionRequestReference string | null 255
returnTransaction BankTransfer
reasonCode string 255 See OutboundTransferReturnReasons
reasonDescription string 255
Example
{  
   "returnedTransactionId":1,
   "returnedTransactionRequestReference": "123456789",
   "returnTransaction":{  
      "id":2,
      "settlementAmount":1255,
      "settlementCurrency":"826",
      "instructedAmount":1255,
      "instructedCurrency":"826",
      "sourceBankAccountAddress":{  
         "id":1,
         "accountNumber":"32936187",
         "iban":"GB36SRLG04000000000000",
         "sortCode":"040059",
         "country": "826",
         "bic":"SRXXXXXX"
      },
      "destinationBankAccountAddress":{  
         "id":2,
         "accountNumber":"38089896",
         "iban":"GB36SRLG04000000000001",
         "sortCode":"040059",
         "country": "826",
         "bic":"SRXXXXXX"
      },
      "createdAt":"2019-03-08T08:43:07+00:00",
      "type":"SINGLE_IMMEDIATE_PAYMENT",
      "scheme":"SCT",
      "requestReference": "REQREF123456951F"
   },
   "reasonCode":"ACCOUNT_BLOCKED",
   "reasonDescription":"Account blocked"
}

Held

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-outbound-held POST
Request
Parameter Type Length Description
outboundTransactionId int(11) 20
updatedAt datetime 25
transaction BankTransfer
Example
{  
   "outboundTransactionId":1,
   "updatedAt": "2019-03-08T08:45:07+00:00",
   "transaction": {  
      "id":2,
      "settlementAmount":1255,
      "settlementCurrency":"826",
      "instructedAmount":1255,
      "instructedCurrency":"826",
      "sourceBankAccountAddress": {  
         "id":1,
         "iban":"GB36SRLG04000000000000",
         "accountNumber":"32936187",
         "sortCode":"040059",
         "country": "826",
         "bic":"SRXXXXXX"
      },
      "destinationBankAccountAddress": {  
         "id":2,
         "iban":"GB36SRLG04000000000001",
         "accountNumber":"38089896",
         "sortCode":"040059",
         "country": "826",
         "bic":"SRXXXXXX"
      },
      "requestReference": "123456789",
      "createdAt":"2019-03-08T08:43:07+00:00",
      "type":"SINGLE_IMMEDIATE_PAYMENT",
      "scheme":"SCT"
   }
}

Settled

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-outbound-settled POST
Request
Parameter Type Length Description
outboundTransactionId int 20
transactionIdentifier string | null 100 Unique external transaction identifier
endToEndIdentifier string | null 100 Transaction end to end identifier. For now - only for ClearBank.
transaction BankTransfer
updatedAt datetime 25
Example
{  
   "outboundTransactionId":20,
   "transactionIdentifier": "TX123456789",
   "endToEndIdentifier": "12345678910",
   "transaction":{  
      "id":2,
      "requestReference": "MY-TX-REF-0000000002",
      "settlementAmount":1255,
      "settlementCurrency":"826",
      "instructedAmount":1255,
      "instructedCurrency":"826",
      "sourceBankAccountAddress":{  
         "id":1,
         "accountNumber":"32936187",
         "iban":"GB36SRLG04000000000000",
         "sortCode":"040059",
         "country": "826",
         "bic":"SRXXXXXX"
      },
      "destinationBankAccountAddress":{  
         "id":2,
         "accountNumber":"38089896",
         "iban":"GB36SRLG04000000000001",
         "sortCode":"040059",
         "country": "826",
         "bic":"SRXXXXXX"
      },
      "details": {
        "senderData": {
          "name": "Money Sender Comp.",
          "iban": "GB36SRLG04000000000000",
          "country": "826",
          "addressLineOne": "67889 ST MARY",
          "addressLineTwo": "London"
        },
        "receiverData": {
          "name": "Money Receiver Comp.",
          "iban": "GB36SRLG04000000000001",
          "country": "826",
          "addressLineOne": null,
          "addressLineTwo": null
        },
        "note": "Payment for flat rent.",
        "purpose": null
      },
      "createdAt":"2019-03-08T08:43:07+00:00",
      "type":"SINGLE_IMMEDIATE_PAYMENT",
      "scheme":"SCT"
   },
   "updatedAt":"2019-03-08T08:43:07+00:00"
}

Rejected

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-outbound-rejected POST
Request
Parameter Type Length Description
outboundTransactionId int 20
reasonDescription string 255
updatedAt datetime 25
transaction BankTransfer
Example
{  
    "outboundTransactionId":20,
    "reasonDescription": "Reasons not specified",
    "updatedAt":"2019-03-08T08:43:07+00:00",
    "transaction":{  
        "id":20,
        "requestReference": "MY-TX-REF-0000000002",
        "settlementAmount":1255,
        "settlementCurrency":"826",
        "instructedAmount":1255,
        "instructedCurrency":"826",
        "bankProviderReasonCode": "MS01",
        "sourceBankAccountAddress":{  
            "id":1,
            "accountNumber":"32936187",
            "iban":"GB36SRLG04000000000000",
            "sortCode":"040059",
            "country": "826",
            "bic":"SRXXXXXX"
        },
        "destinationBankAccountAddress":{  
            "id":2,
            "accountNumber":"38089896",
            "iban":"GB36SRLG04000000000001",
            "sortCode":"040059",
            "country": "826",
            "bic":"SRXXXXXX"
        },
        "details": {
          "senderData": {
            "name": "Money Sender Comp.",
            "iban": "GB36SRLG04000000000000",
            "country": "826",
            "addressLineOne": "67889 ST MARY",
            "addressLineTwo": "London"
          },
          "receiverData": {
            "name": "Money Receiver Comp.",
            "iban": "GB36SRLG04000000000001",
            "country": "826",
            "addressLineOne": null,
            "addressLineTwo": null
          },
          "note": "Payment for flat rent.",
          "purpose": null
        },
        "createdAt":"2019-03-08T08:43:07+00:00",
        "type":"SINGLE_IMMEDIATE_PAYMENT",
        "scheme":"SCT"
    }
}

Cancel rejected

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-outbound-cancel-rejected POST
Request
Parameter Type Length Description
canceledTransactionId int 20
canceledTransactionRequestReference string | null 255
reason string 255 See Transaction instruction reasons
Example
{  
   "canceledTransactionId": 144,
   "canceledTransactionRequestReference": "123456789",
   "reason": "ACCOUNT_CLOSED"
}

Transaction status changed

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-status-changed POST

Request

Parameter Type Length Description
transactionId int 20
updatedAt datetime 25
status string 8 See BankTransferStatuses
reasonDescription string 255
transaction BankTransfer
Example
{
    "transactionId": 2,
    "updatedAt": "2019-03-08T08:45:07+00:00",
    "status": "ACCEPTED",
    "reasonDescription": "",
    "transaction": { 
        "id": 2,
        "settlementAmount":1255,
        "settlementCurrency":"826",
        "instructedAmount":1255,
        "instructedCurrency":"826",
        "sourceBankAccountAddress": {  
            "id":1,
            "iban":"GB36SRLG04000000000000",
            "accountNumber":"32936187",
            "sortCode":"040059",
            "country": "826",
            "bic":"SRXXXXXX"
        },
        "destinationBankAccountAddress": {  
            "id":2,
            "iban":"GB36SRLG04000000000001",
            "accountNumber":"38089896",
            "sortCode":"040059",
            "country": "826",
            "bic":"SRXXXXXX"
        },
        "details": {
          "senderData": {
            "name": "Money Sender Comp.",
            "iban": "GB36SRLG04000000000000",
            "country": "826",
            "addressLineOne": "67889 ST MARY",
            "addressLineTwo": "London"
          },
          "receiverData": {
            "name": "Money Receiver Comp.",
            "iban": "GB36SRLG04000000000001",
            "country": null,
            "addressLineOne": null,
            "addressLineTwo": null
          },
          "note": "Intern Company note",
          "purpose": "1234"
        },
        "reference":"AB12345",
        "createdAt":"2019-03-08T08:43:07+00:00",
        "direction": "INBOUND",
        "status": "ACCEPTED",
        "type": "SINGLE_IMMEDIATE_PAYMENT",
        "scheme":"SCT"
    }
}

Transaction instruction

Cancel instruction

Created

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-cancel-instruction-created POST
Request
Parameter Type Length Description
instructionId int 20
transactionId int 20
requestReference string | null 255
type string 35 See Transaction instruction types
status string 8 See Transaction instruction statuses
reasonCode string 255 See Transaction instruction reasons
createdAt datetime 25
willFinishAt datetime 25
Example
{ 
   "instructionId": 123456,
   "transactionId": 12345610,
   "type": "INBOUND_CANCEL",
   "status": "PENDING",
   "reasonCode": "DUPLICATE_PAYMENT",
   "createdAt": "2019-08-01T14:10:27+00:00",
   "willFinishAt": "2019-08-11T14:10:27+00:00"
}

Updated

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-cancel-instruction-updated POST
Request
Parameter Type Length Description
instructionId int 20
transactionId int 20
requestReference string | null 255
type string 35 See Transaction instruction types
status string 8 See Transaction instruction statuses
reasonCode string 255 See Transaction instruction reasons
createdAt datetime 25
updatedAt datetime | null 25
willFinishAt datetime 25
Example
{
  "instructionId": 123456,
  "transactionId": 12345610,
  "type": "INBOUND_CANCEL",
  "status": "REJECTED",
  "reasonCode": "DUPLICATE_PAYMENT",
  "createdAt": "2019-08-01T14:10:27+00:00",
  "updatedAt": "2019-08-02T14:57:20+00:00",
  "willFinishAt": "2019-08-11T14:10:27+00:00"
}

Resolution of investigation instruction

Created

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-resolution-of-investigation-instruction-created POST
Request
Parameter Type Length Description
originalInstructionId int 20
transactionId int 20
requestReference string | null 255
type string 35 See Transaction instruction types
status string 8 See Transaction instruction statuses
reasonCode string 255 See Transaction instruction reasons
createdAt datetime 25
Example
{
  "originalInstructionId": 123456,
  "instructionId": 123457,
  "transactionId": 12345610,
  "type": "INBOUND_RESOLUTION_OF_INVESTIGATION",
  "status": "PENDING",
  "reasonCode": "LEGAL_DECISION",
  "createdAt": "2019-08-02T14:58:53+00:00"
}

Updated

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/transaction-resolution-of-investigation-instruction-updated POST
Request
Parameter Type Length Description
originalInstructionId int 20 Parent cancel instruction ID
instructionId int 20
transactionId int 20
requestReference string | null 255
type string 35 See Transaction instruction types
status string 8 See Transaction instruction statuses
reasonCode string 255 See Transaction instruction reasons
createdAt datetime 25
updatedAt datetime | null 25
Example
{
  "originalInstructionId": 123456,
  "instructionId": 123457,
  "transactionId": 12345610,
  "type": "INBOUND_RESOLUTION_OF_INVESTIGATION",
  "status": "ACCEPTED",
  "reasonCode": "LEGAL_DECISION",
  "createdAt": "2019-08-02T14:58:53+00:00",
  "updatedAt": "2019-08-02T14:59:20+00:00"
}

Exchanges

Exchange

Created

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/currency-exchange-created POST
Request
Parameter Type Length Description
exchange Exchange
Example
{
    "exchange": {
        "id": 1,
        "sourceBankAccountAddress": {
            "id": 1,
            "ownerName": "testingaccount",
            "accountName": "testingaccount",
            "accountNumber": "F36462860",
            "country": "826"
        },
        "goalAmount": 500,
        "boughtAmount": 0,
        "soldAmount": 0,
        "sourceCurrency": "978",
        "targetCurrency": "826",
        "requestReference": "A00000000027",
        "transactions": [],
        "goalType": "SELL",
        "status": "ACTIVE"
    }
}

Updated

URL Method
%YOUR_REGISTERED_NOTIFICATION_URL%/currency-exchange-updated POST
Request
Parameter Type Length Description
exchange Exchange
Example
{
    "exchange": {
        "id": 1,
        "sourceBankAccountAddress": {
            "id": 1,
            "ownerName": "testingaccount",
            "accountName": "testingaccount",
            "accountNumber": "F36462860",
            "country": "826"
        },
        "goalAmount": 500,
        "boughtAmount": 423,
        "soldAmount": 499,
        "sourceCurrency": "978",
        "targetCurrency": "826",
        "requestReference": "A00000000027",
        "transactions": [{
            "id": 1,
            "settlementAmount": 499,
            "settlementCurrency": "978",
            "instructedAmount": 499,
            "instructedCurrency": "978",
            "sourceBankAccountAddress": {
                "id": 1,
                "ownerName": "testingaccount",
                "accountName": "testingaccount",
                "accountNumber": "F36462860",
                "country": "826"
            },
            "transactionIdentifier": "EXCHANGE-SELL-1618394718771",
            "createdAt": "2021-04-14T10:05:19+00:00",
            "exchange": 1,
            "direction": "OUTBOUND",
            "status": "ACCEPTED",
            "type": "SINGLE_IMMEDIATE_PAYMENT",
            "scheme": "EXCHANGE"
        }, {
            "id": 2,
            "settlementAmount": 423,
            "settlementCurrency": "826",
            "instructedAmount": 423,
            "instructedCurrency": "826",
            "destinationBankAccountAddress": {
                "id": 2,
                "ownerName": "testingaccount",
                "accountName": "testingaccount",
                "accountNumber": "F36462860",
                "country": "826"
            },
            "transactionIdentifier": "EXCHANGE-BUY-1618394718771",
            "createdAt": "2021-04-14T10:05:19+00:00",
            "exchange": 1,
            "direction": "INBOUND",
            "status": "ACCEPTED",
            "type": "SINGLE_IMMEDIATE_PAYMENT",
            "scheme": "EXCHANGE"
        }, {
            "id": 3,
            "settlementAmount": 1,
            "settlementCurrency": "978",
            "instructedAmount": 1,
            "instructedCurrency": "978",
            "sourceBankAccountAddress": {
                "id": 1,
                "ownerName": "testingaccount",
                "accountName": "testingaccount",
                "accountNumber": "F36462860",
                "country": "826"
            },
            "transactionIdentifier": "EXCHANGE-FEE-1618394718771",
            "createdAt": "2021-04-14T10:05:19+00:00",
            "exchange": 1,
            "direction": "OUTBOUND",
            "status": "ACCEPTED",
            "type": "DEBIT_FEE",
            "scheme": "EXCHANGE"
        }],
        "goalType": "SELL",
        "status": "COMPLETED"
    }
}

Appendix

Changelog

Version Date Updates
1.0.28 June 21, 2021 Added optional parameter 'requestReference' to BankAccountAddress request
1.0.27 April 28, 2021 New bank provider and support for currency exchanges in some bank providers.
1.0.26 April 22, 2021 Added mandate object to mandate webhooks data
1.0.25 April 06, 2021 Added Direct debit mandate finished webhook
1.0.24 March 24, 2021 Changed all identifiers from int to bigint.
1.0.23 March 09, 2021 Added new BankAccountAddressType field to BankAccountAddressCreate, BankAccountAddressUpdate, BankAccountAddressBusinessCreate, BankAccountAddressBusinessUpdate.
1.0.22 March 04, 2021 Changed address from optional to conditional in BankAccountCompanyUpdate and BankAccountCompany
1.0.22 March 03, 2021 Changed max accountNumber length of BankAccountAddress and all assosiated webhooks (from 34 to 26).
1.0.21 January 26, 2021 Changed address length of BankAccountHolder, BankAccountHolderUpdate, BankAccountCompany, BankAccountCompanyUpdate from 100 chars to 70 chars.
1.0.20 January 12, 2021 Removed transaction-outbound-cancel-created webhook on successful outbound transfer cancel and replaced it with OutboundReturned transaction type: OUTBOUND_CANCEL was removed and such transactions are now considered as returns.
1.0.19 December 08, 2020 Added destinationMandate field to BankTransfer.
1.0.18 November 25, 2020 Added new reference, transactionIdentifier and endToEndIdentifier fields to transaction webhooks, e.g.: DirectDebitPaid, DirectDebitDue, DirectDebitRejected.
1.0.17 November 24, 2020 Added new error codes to Api errors enum.
1.0.16 October 29, 2020 Added new optional transactionId field in TransactionBankAccountAddressRequest api call.
1.0.15 October 28, 2020 Updated Create bank account address mandate api call. CreateMandateOriginatorBankAccountAddress accountName length changed from 40 to 18 symbols.
1.0.14 October 5, 2020 Documented custom rules for bank-transfer/outbound endpoint for some providers
1.0.13 September 22, 2020 Added bank provider reason code to BankTransfer. Added new webhooks: Outbound return created and Outbound return rejected. Added new api call Return transfer which can be used to return FPS/CHAPS/DD/DC transfers. Added reason field to ChangeDirectDebitStatus api call.
1.0.12 September 16, 2020 Added new conditional fields to: BankAccountHolder, BankAccountHolderUpdate, BankAccountCompany, BankAccountCompanyUpdate definitions.
1.0.11 July 16, 2020 Updated and added new API calls:
Create bank account address mandate
Amend bank account address mandate
Reject bank account address mandate
Cancel bank account address mandate
Get bank account address mandates

Added new webhooks:
Mandate activated
Mandate activation failed
Mandate migrated
1.0.10 June 29, 2020 Added field length column
1.0.9 June 29, 2020 'requestReference' field has been added in Bank account address Create action, Create business action, Get details action response, Appendix type.
1.0.8 June 18, 2020 Added missing field lengths
1.0.7 June 11, 2020 Added new API call Resend latest transfer webhook
1.0.6 May 19, 2020 Added new fields in Transaction bank account address action response ('sourceMandateOriginator', 'reference', 'transactionIdentifier', 'endToEndIdentifier', 'details', 'updatedAt')
'details' parameter has been added to Outbound settled and Outbound rejected
'sourceMandateOriginator', 'returnDetails', 'reference', 'transactionIdentifier', 'endToEndIdentifier', 'updatedAt' fields have been added to BankTransfer type.
1.0.5 May 08, 2020 'postaCode', 'city', 'state', 'country' fields have been added to BankAccountCompany and BankAccountCompanyUpdate types for Business bank account address create and Business bank account address update actions.
1.0.4 April 22, 2020 'providerName' field has been added to Bank account address Create webhook.
'scheme', 'requestReference' and 'type' fields have been added to Create outbound response.
Updated 'scheme', 'type' fields in Direct credit received, Direct debit, Payment webhooks.
New Bank account address actions have been added: Update, Update business
New webhook has been added Bank account address details changed
1.0.3 April 10, 2020 New Bank account Get balances action has been added.
1.0.2 April 08, 2020 New Security appendix has been added. New request headers are needed for API requests.
1.0.1 April 06, 2020 New Transaction status changed webhook has been added.
Details and reference fields has been added to Inbound Held webhook.
1.0.0 March 25, 2020 Initial version.

Security

Authentication

Action

These headers are mandatory when making API requests.

Request header
Parameter Type Length Required Description
x-auth-token string 100 Yes Your API token
x-auth-signature string 128 Yes See Action signature hash generating
x-auth-signature-timestamp string 19 Yes Unix timestamp

Webhook

In order to encrypt request - encryption should be done in the endpoint configuration.

Request header
Parameter Type Length Required Description
x-hook-signature string 88 Yes See Webhook signature hash generating

Hash generating

Action signature

To generate a 'x-auth-signature' hash, SHA-512 algorithm must be used.

Data that is hashed should be taken from the request parameters in JSON format and your 'notification secret' which is used as a prefix and 'x-auth-signature-timestamp' which is used as a suffix (no special separators are used). Hash format - lowercase hexits.

Finally set your 'x-auth-signature' in request header data.

Webhook signature

To generate a hash that can be compared with 'x-hook-signature', SHA-512 algorithm must be used.

Data that is hashed should be taken from the request (in this case it is in JSON format) and your 'notification secret' which is used as a prefix (no special separators are used). Hash format - Binary.

Finally, use base64 encode and compare your data with 'x-hook-signature' request header data. If it does not match - it is a problem, someone is participating in the middle.

Type

BankAccountBalance

Parameter Type Length Required Description
amount int 20 Yes
currency string 3 Yes Currency ISON.

Paginator

Parameter Type Required Description
limit int Yes Number of items per page
page int Yes Current page number
pagesCount int | null No Total number of pages

BankAccountAddress

Parameter Type Length Required Description
id int 20 Yes
accountNumber string | null 26 No Must be provided if iban is null
accountName string 255 Yes Account/Owner name of the bank account address
iban string | null 34 No Must be provided if accountNumber and sortCode are null
bban string | null 30 No
sortCode string | null 6 No Must be provided if iban is null
bic string | null 12 No
country string | null 3 No
inboundEnabled bool 1 Yes
outboundEnabled bool 1 Yes
directDebitEnabled bool 1 Yes
directCreditEnabled bool 1 Yes
providerName string 50 No See BankProviders
requestReference string 255 No

BankAccountHolder

Parameter Type Length Required Description
title string 7 No
firstName string 50 Yes
lastName string 50 Yes
addressLineOne string 70 Yes
addressLineTwo string 70 No
addressLineThree string 70 No
addressLineFour string 70 No
postalCode string 9 Yes
city string 50 Yes Length depends on bank provider.
state string 50 No
country string 3 Yes
phone string 15 Yes
email string 255 Conditional Depends on bank provider.
dateOfBirth string 255 Conditional Depends on bank provider.

BankAccountHolderUpdate

Parameter Type Length Required Description
firstName string 50 No Depends on bank provider.
lastName string 50 No Depends on bank provider.
addressLineOne string 70 No
addressLineTwo string 70 No Empty value is available.
addressLineThree string 70 No Empty value is available.
addressLineFour string 70 No Empty value is available.
postalCode string 9 No
city string 50 No Length depends on bank provider.
state string 50 No Empty value is available.
country string 3 No
phone string 15 No
email string 15 No

BankAccountCompany

Parameter Type Length Required Description
name string 50 Yes
type string 255 Conditional See CompanyTypes.
registrationNumber string 255 Conditional Depends on bank provider.
addressLineOne string 70 Contidional Depends on bank provider.
addressLineTwo string 70 No
addressLineThree string 70 No
addressLineFour string 70 No
postalCode string 9 Contidional Depends on bank provider.
city string 50 Contidional Depends on bank provider.
state string 50 No
country string 3 Contidional Depends on bank provider.
contactName string 255 Conditional Depends on bank provider.
phone string 15 Conditional Depends on bank provider.
email string 255 Conditional Depends on bank provider.

BankAccountCompanyUpdate

Parameter Type Length Required Description
name string 50 No
addressLineOne string 70 Contidional Depends on bank provider.
addressLineTwo string 70 No
addressLineThree string 70 No
addressLineFour string 70 No
postalCode string 9 Contidional Depends on bank provider.
city string 50 Contidional Depends on bank provider.
state string 50 No
country string 3 Contidional Depends on bank provider.
contactName string 255 No
email string 255 No
phone string 15 No

BankTransfer

Parameter Type Length Required Description
id int 20 Yes Bank transfer ID.
settlementAmount int 20 Yes
settlementCurrency string 3 Yes Currency ISON.
instructedAmount int 20 Yes
instructedCurrency string 3 Yes Currency ISON.
exchange int | null 20 No Available for Exchange related transactions
destinationMandate Mandate No Available for DirectDebit transactions
sourceMandateOriginator MandateOriginator | null No
sourceBankAccountAddress BankAccountAddress Yes
destinationBankAccountAddress BankAccountAddress Yes
details TransactionDetails No
returnDetails TransactionReturnDetails No Can be available when transaction type is: INBOUND_PAYMENT_RETURN, OUTBOUND_PAYMENT_RETURN or PAYMENT_CANCEL
bankProviderReasonCode string | null 255 No Reason code provided by bank provider.
requestReference string | null 255 No Request reference of transfer
reference string | null 255 No Reference of transfer
transactionIdentifier string | null 100 No Unique external transaction identifier
endToEndIdentifier string | null 100 No Transaction end to end identifier.
createdAt string 19 Yes
updatedAt string 19 No
direction string 8 No See BankTransferDirections
status string 8 No See BankTransferStatuses
scheme string 255 No See BankTransferSchemes
type string 255 No See BankTransferTypes

CurrencyAndAmount

Parameter Type Length Required Description
currency string 3 Yes
minorUnits int 20 Yes

DirectDebitTransaction

Parameter Type Length Required Description
id int 20 Yes Bank transfer ID.
settlementAmount int 20 Yes
settlementCurrency string 3 Yes Currency ISON.
instructedAmount int 20 Yes
instructedCurrency string 3 Yes Currency ISON.
sourceBankAccountAddress BankAccountAddress Yes
destinationBankAccountAddress BankAccountAddress | null No
destinationMandate Mandate Yes
reference string | null 255 No Reference of transfer
transactionIdentifier string | null 100 No Unique external transaction identifier
endToEndIdentifier string | null 100 No Transaction end to end identifier.
details TransactionDetails | null No Additional details about transaction
scheme string 255 Yes See BankTransferSchemes
type string 255 Yes See BankTransferTypes
createdAt string 19 Yes

InboundTransfer

Parameter Type Length Required Description
transactionId int 11 Yes
reference string 18 Yes

InboundReturnTransfer

Parameter Type Length Required Description
id int 20 Yes Bank transfer ID.
returnTransactionId int 20 Yes Bank transfer ID.
settlementAmount int 20 Yes
settlementCurrency string 3 Yes Currency ISON.
instructedAmount int 20 Yes
instructedCurrency string 3 Yes Currency ISON.
sourceBankAccountAddress BankAccountAddress Yes
destinationBankAccountAddress BankAccountAddress Yes
status string 8 Yes See BankTransferStatuses
scheme string 255 No See BankTransferSchemes
type string 255 Yes INBOUND_PAYMENT_RETURN
reference string 18 No
requestReference string 255 No
reasonCode string 4 Yes See ReturnReasons
transactionIdentifier string | null 100 No Unique external transaction identifier
endToEndIdentifier string | null 100 No Transaction end to end identifier.
createdAt string 19 Yes

OutboundTransfer

Parameter Type Length Required Description
sourceBankAccountAddressId int 20 Yes
destinationBankAccountAddress BankAccountAddress Yes
currencyAndAmount CurrencyAndAmount Yes
reference string 18 Yes
requestReference string | null 255 No
destinationDetails DestinationDetails No

OutboundTransferDestinationDetails

Parameter Type Length Required Description
address string | null 70 Conditional Required for some bank providers.
postal string | null 20 Conditional Required for some bank providers.
city string | null 20 Conditional Required for some bank providers.
country string | null 3 Conditional Required for some bank providers.
note string | null 140 No This field is for remittance information. For ClearBank - max 35 characters.
purpose string | null 4 No ISO 20022 external purpose code

Mandate

Parameter Type Length Required Description
id int 20 Yes
originator string 255 Yes MandateOriginator
type string 255 Yes MandateType
status string 255 Yes MandateStatus
reference string 35 Yes Reference
requestReference string 255 No Unique reference to track mandate

MandateOriginator

Parameter Type Length Required Description
id int 20 Yes
name string 255 Yes
serviceUserNumber string 255 Yes

MandateOriginatorBankAccountAddress

Parameter Type Length Required Description
accountName string 255 Conditional Name of the account.
iban string 34 Conditional IBAN, required if accountNumber and sortCode are empty.
accountNumber string 26 Conditional Requred if IBAN is empty.
sortcode string 6 Conditional Requred if IBAN is empty.

CreateMandateOriginatorBankAccountAddress

Parameter Type Length Required Description
accountName string 18 Conditional Name of the account.
iban string 34 Conditional IBAN, required if accountNumber and sortCode are empty.
accountNumber string 26 Conditional Requred if IBAN is empty.
sortcode string 6 Conditional Requred if IBAN is empty.

TransactionReturnDetails

Parameter Type Length Required Description
returnedTransactionId int 20 Yes
reason string 255 Yes Reason description
reasonCode string | null 255 No Check Reason codes

TransactionDetails

Parameter Type Length Required Description
senderData TransactionDetailsPartyData | null No
receiverData TransactionDetailsPartyData | null No
purpose string | null 255 No
note string | null 255 No
debitType string | null 10 No For debit transactions only

TransactionDetailsPartyData

Parameter Type Length Required Description
name string | null 50 No
iban string | null 34 No
addressLineOne string | null 100 No
addressLineTwo string | null 100 No
country string | null 3 No

Exchange

Parameter Type Length Required Description
id int 20 Yes
sourceBankAccountAddress BankAccountAddress Yes
goalAmount int 20 Yes
boughtAmount int 20 Yes
soldAmount int 20 Yes
sourceCurrency string 3 Yes ISON
targetCurrency string 3 Yes ISON
requestReference string 255 Yes
goalType string 255 Yes See ExchangeTypes
status string 255 Yes See ExchangeStatuses
transactions BankTransfer[] Yes

ExchangeQuoteFee

Parameter Type Length Required Description
percentage float Yes
amount int 20 Yes
currencyIson string 3 Yes

TransactionInstruction

Parameter Type Length Required Description
id int 20 Yes
requestReference string 255 No
type string 255 Yes See Transaction instruction types
status string 8 Yes See Transaction instruction statuses
reasonCode string 255 Yes See Transaction instruction reasons
createdAt string 19 Yes

Enum

Bank account address

Types

Id Type Description
1 VIRTUAL_ACCOUNT Client funds account.
2 ACCOUNT Main funds account.
3 BANK_FUNDS Bank funds account.

Mandate

Types

Id Type Description
1 PAPER Paper mandate.
2 ORIGINATION Origination mandate.
3 MIGRATED Mandate migrated from Paper to Origination.

Statuses

Id Type Description
1 ACTIVE Mandate is active.
2 CANCELED Mandate got cancelled.
3 ERROR Mandate creation failed.
4 PENDING Mandate is pending.
5 FINISHED Mandate is finished. No more transactions will be made.

Exchange

Types

Id Type Description
1 SELL Selling exchange.
2 BUY Buying exchange.

Statuses

Id Type Description
1 COMPLETED Exchange is completed.
2 PENDING Exchange is pending.
3 ACTIVE Exchange is active.
4 REJECTED Exchange is rejected.

BankTransfer

Schemes

Id Status value Description
1 TRANSFER Transfer.
2 FPS Faster payments.
3 CHAPS Chaps scheme.
4 BACS Bacs scheme.
5 SCT SEPA transfer
6 SCTI SEPA instant transfer
7 SDD SEPA direct debit
8 EXCHANGE Transfer of exchange

Statuses

Status value Description
ACCEPTED Accepted.
PENDING Pending.
REVERSED Reversed.
REJECTED Rejected.
HELD Held.

Types

Type value Description
SINGLE_IMMEDIATE_PAYMENT Single immediate payment
FORWARD_DATE_PAYMENT Forward date payment.
STANDING_ORDER_PAYMENT Standing order payment.
INBOUND_PAYMENT_RETURN Inbound payment return.
OUTBOUND_PAYMENT_RETURN Outbound payment return.
DIRECT_DEBIT_PAYMENT Direct debit payment.
DIRECT_CREDIT_PAYMENT Direct credit payment.
PAYMENT_REVERSE Payment reverse.
PAYMENT_CANCEL Payment cancel.
DEBIT_FEE Debit fee.

Directions

Direction value Description
INBOUND Inbound.
OUTBOUND Outbound.

TransactionInstruction

Types

Type value Description
INBOUND_STATUS_REPORT Inbound status report.
INBOUND_CANCEL Inbound cancel request.
INBOUND_RESOLUTION_OF_INVESTIGATION Inbound resolution of investigation.
INBOUND_REQUEST_FOR_STATUS_UPDATE Inbound request for status update.

Statuses

Status value Description
ACCEPTED Accepted.
PENDING Pending.
REJECTED Rejected.

Reasons

Reason code Description
DUPLICATE_PAYMENT Duplicate payment.
WRONG_IBAN Wrong Bank account address.
WRONG_AMOUNT Wrong amount.
FRAUDULENT_ORIGINAL_CREDIT_TRANSFER Fraudulent original credit transfer.
TECHNICAL_PROBLEM Technical problem.
FOLLOWING_CANCELATION_REQUEST Following cancellation request.
REQUESTED_BY_CUSTOMER Requested by customer.
ACCOUNT_CLOSED Account is closed.
INSUFFICIENT_FUNDS Insufficient funds.
ALREADY_RETURNED_TRANSACTION Transaction is already returned.
LEGAL_DECISION Legal decision.
NO_ANSWER_FROM_CUSTOMER No answer from customer.
NO_ORIGINAL_TRANSACTION_RECEIVED No original transaction received.

Reason

ReturnReasons

Reason code Description Transfer Direct Debit Direct Credit
INCORRECT_ACCOUNT_NUMBER Incorrect account number. Yes Yes Yes
ACCOUNT_CLOSED Account is closed. Yes Yes Yes
ACCOUNT_BLOCKED Account is blocked. Yes Yes Yes
ACCOUNT_HOLDER_DECEASED Account holder deceased. Yes Yes Yes
NOT_SPECIFIED_REASON_BY_CUSTOMER Reason not specified by customer. Yes Yes No
NOT_SPECIFIED_REASON_BY_AGENT Reason not specified by agent. Yes No No
TRANSACTION_FORBIDDEN Forbidden transaction. Yes No No
INVALID_BANK_OPERATION_CODE Invalid bank operation code. Yes No No
DUPLICATION Duplication. Yes No No
MISSING_CREDITOR_ADDRESS MIssing creditor's address. Yes Yes Yes
FOLLOWING_CANCELATION_REQUEST Following cancellation request. Yes Yes No
MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION Missing debtor's account or identification. Yes Yes Yes
MISSING_DEBTOR_NAME_OR_ADDRESS Missing debtor's name or address. Yes Yes Yes
MISSING_CREDITOR_NAME_OR_ADDRESS Missing creditor's name or address. Yes Yes Yes
REGULATORY_REASON Regulatory reason. Yes No No
OTHER Other reason. Yes Yes No
REFERENCE_REQUIRED_NOT_SUPPLIED Required reference not supplied. Yes No No
ACCOUNT_NAME_MISSMATCH Account name missmatch. Yes Yes Yes
TERMS_AND_CONDITIONS_OF_ACCOUNT_DO_NOT_PERMIT_CREDITING_OF_THESE_FUNDS Terms and conditions of account do not permit crediting of these funds. Yes No No
ACCOUNT_TRANSFERRED Account transferred. Yes Yes Yes
SENDING_INSTITUTION_ACTION_REQUIRED Sending institution action required. Yes No No
PAYMENT_RETURN_REASON_REASON_NOT_SPECIFIED Not specified payment return reason. Yes No No

OutboundTransferReturnReasons

Reason code Description
OTHER Other.
INCORRECT_ACCOUNT_NUMBER Incorrect account number.
ACCOUNT_CLOSED Account is closed.
ACCOUNT_BLOCKED Account is blocked.
ACCOUNT_NAME_MISSMATCH Account name missmatch.
ACCOUNT_CANNOT_BE_IDENTIFIED Account can not be identified.
INCORRECT_TRANSACTION_INORMATION Incorrect transaction information.
ACCOUNT_HOLDER_DECEASED Account holder deceased.
FRAUDULENT_PAYMENT_SUSPECTED Fraudulent payment suspected.
PROVIDER_ISSUE Provider issue.
TIME_OUT Time out.
TECHNICAL_PROBLEM Technical problems.
DUPLICATION Duplication.
ERI_OPTION_NOT_SUPPORTED ERI option not supported.
REGULATORY_REASON Regulatory reason.
INVALID_BANK_OPERATION_CODE Invalid bank operation code.
MISSING_CREDITOR_ADDRESS Missing creditor address.
FOLLOWING_CANCELATION_REQUEST Following cancelation request.
MISSING_DEBTOR_ACCOUNT_OR_IDENTIFICATION Missing debtor account or identification.
MISSING_DEBTOR_NAME_OR_ADDRESS Missing debtor name or address.

InboundCancelRequestDeclineReasons

Reason code Description
REQUESTED_BY_CUSTOMER Requested by customer.
ACCOUNT_CLOSED Account is closed.
INSUFFICIENT_FUNDS Insufficient funds.
ALREADY_RETURNED_TRANSACTION Transaction is already returned.
LEGAL_DECISION Legal decision.
NO_ANSWER_FROM_CUSTOMER No answer from customer.
NO_ORIGINAL_TRANSACTION_RECEIVED No original transaction received.

MandateRejectionReasons

Reason code Description
CANCELLED_BY_PAYER Payer has instructed paying bank to cancel DDI
PAYER_DECEASED Payer deceased.
ACCOUNT_TRANSFERED_TO_DIFFERENT_INSTITUTION Account transferred to another bank / building society.
ACCOUNT_NOT_FOUND Account number is not recognised at the paying bank.
MANDATE_INSTRUCTION_NOT_FOUND Instruction does not exist on paying bank’s database (only applies to receipt of a 0C).
PAYER_ACCOUNT_CLOSED Payer has closed his account for an unknown reason.
ACCOUNT_MOVED_TO_DIFFERENT_BRANCH New account details supplied to the service user by paying bank.
INVALID_PAYEE_ACCOUNT_TYPE Paying bank does not allow Direct Debits on this type of account.
PAYEE_ACCOUNT_DIRECT_DEBIT_DISABLED Paying bank does not allow Direct Debits on this account.
INSTRUCTION_HAS_EXPIRED Occurs when a service user attempts to convert a DDI which is shown as expired on the paying bank’s database.
PAYER_REFERENCE_NOT_UNIQUE Paying bank has matched the DDI to an existing DDI with a similar reference that has more or fewer characters.
PAYER_CANCELLED_DDI Paying bank has cancelled the DDI.

MandateCancellationReasons

Reason code Description
CANCELLED_BY_INSTITUTION Institution cancelled - refer to payer. Paying bank has cancelled instruction.
CANCELLED_BY_PAYER Instruction cancelled by payer. Payer has instructed the paying bank to cancel the DirectDebit Instruction (Mandate).
PAYER_DECEASED Payer deceased
ACCOUNT_CLOSED Account closed. Payer has closed their account for an unknown reason.

MandateAmendmentReasons

Reason code Description
ACCOUNT_TRANSFERED Mandate amended due to account transfer.
INSTRUCTION_AMENDED Mandate amended.

OutboundCancelReasons

Reason code Additional information required Reason originator name required Description
DUPLICATE_PAYMENT No No Duplicate payment.
WRONG_IBAN Yes Yes Wrong Bank account address.
WRONG_AMOUNT Yes Yes Wrong amount.
FRAUDULENT_ORIGINAL_CREDIT_TRANSFER Yes No Fraudulent original credit transfer.
TECHNICAL_PROBLEM No No Technical problem.
REQUESTED_BY_CUSTOMER Yes Yes Requested by customer.

BankProvider

Provider code Description
CENTROLINK CENTROlink.
STARLING Starling.
CLEARBANK ClearBank.
OPENPAYD OpenPayd.
FREEMARKET FreeMarket.

CompanyTypes

Company type Description
TYPE_LIMITED_LIABILITY Limited liability
TYPE_PARTNERSHIP Partnership
TYPE_PUBLIC_LIMITED_COMPANY Public company
TYPE_JOINT_STOCK_COMPANY Joint stock company
TYPE_CHARITY Charity

Beneficiary

Types

Type Description
INDIVIDUAL Individual account.
COMPANY Company account.

API Errors

Error code Error message
1 Invalid request
2 Client not found
3 Integration account not found
4 Amount limit exceeded
5 Currency not supported
6 Bank account address not found
7 Outbound transfers disabled for bank account
8 Bank account is closed
9 Cannot reverse inbound transaction
10 Transaction not found
11 Invalid transaction status for return
12 Only pending direct debit transaction status can be updated.
13 Internal system error.
14 Currency not active.
15 Currency not found.
16 Client authentication required.
17 Mandate not found.
18 Mandate already canceled.
19 Iban or account number and sort code pair must be provided
20 Only iban or only account number and sort code pair must be provided
21 Iban is required
22 Scheme not supported
23 Country not found
24 Invalid account number
25 Insufficient funds
28 Functionality not supported
26 Bic is required
27 Cannot return outbound transaction
29 Not authorized
30 Return reason is not supported by bank provider.
31 Invalid transaction's cancel request's type.
32 Invalid transaction's cancel request's status.
33 Transaction cancel not found.
34 Cancel instruction's transaction's type is not inbound.
35 Cancel instruction is already expired.
36 Failed to handle request due to not being able to acquire lock.
37 Reference field is missing
38 Cancel instruction already exists.
39 Transaction is already returned.
40 Additional information is required, due to selected reason code.
41 Reason originator name is required, due to selected reason code.
42 Reason code is required
43 You are not allowed to cancel local transfer.
44 Invalid account number or sortcode.
45 Payment accepted
46 Payment rejected
47 Debit payment disabled
48 Request reference already exists
49 Destination details note is invalid. Max 35 characters are allowed.
50 All details are empty, please fill in data that you want to update.
51 We were unable to get holder data.
52 Bank account address is not type of business.
53 Bank account address is type of business.
54 Provider not available at this time.
55 Request reference or transaction id must be provided.
56 Notification not found
57 Bank account is not valid client account
58 Mandate service user number and reference is already in use, please use a different reference.
59 Invalid mandate
60 Reason is not supported by bank provider
61 Destination account name is required
62 Destination account last name is required
63 Destination details are required
64 Destination details country is required
65 Destination details city is required
66 Destination details address is required
67 Destination details postal code is required
68 Destination details note is required
69 Invalid beneficiary
70 Email already used
71 Email and mobile already used
72 Mobile already used
73 Validation error
74 Account holder not found
75 Company already registered
76 Mandate originator name is too long
77 Destination bank account address does not support selected payment scheme
78 Invalid destination bank account address
10001 This value is not a valid datetime.
10002 This value is not a valid date.
10003 This collection should contain less elements.
10004 This collection should contain more elements.
10005 This field was not expected.
10006 This field is missing.
10007 You must select at most {{ limit }} choices.
10008 You must select at least {{ limit }} choices.
10009 One or more of the given values is invalid.
10010 This value should be blank.
10011 This value should be a multiple of {{ compared_value }}.
10012 This value is not a valid email address.
10013 This value should be equal to {{ compared_value }}.
10014 This value is not valid.
10015 This value should be greater.
10016 This value should be greater than or equal to {{ compared_value }}.
10017 This is not a valid International Bank Account Number (IBAN).
10018 This value should be identical to {{ compared_value_type }} {{ compared_value }}.
10019 This value is too short.
10020 This value is too long.
10021 This value does not match the expected charset.
10022 This value should be less.
10023 This value should be less than or equal to {{ compared_value }}.
10024 This value should not be blank.
10025 This value should not be equal to {{ compared_value }}.
10026 This value should not be identical to {{ compared_value_type }} {{ compared_value }}.
10027 This value should not be null.
10028 This value should be a valid number.
10029 This value should be smaller.
10030 This value should be bigger.
10031 This value is not a valid time.
10032 Invalid type.
10033 This is not a valid Business Identifier Code (BIC).