Examples

Deposit Notification Example

{
  "subject": "TRANSACTION:GBP:1234567812345678",
  "timestamp": "YYYY-MM-DDTHH:MM:SS.000Z",
  "account_id": 1234,
  "transactions": [
    {
      "id": "transaction id here",
      "timestamp": "transaction timestamp here",
      "amount_instructed": 9.99,
      "amount_actual": 9.99,
      "currency": "GBP",
      "credit": true,
      "reference": "sender's reference",
      "bank_name": "",
      "bank_country": "",
      "account_name": "senders name",
      "account_number": "sender's account number available",
      "account_address": "sender's address if available",
      "sort_code": "sender's UK sort code if applicable",
      "iban": "sender's IBAN if available",
      "notes_external": "",
      "from": "sender's name"
    }
  ]
}

Payment Notification Example

{
  "subject": "TRANSACTION:GBP:1234567812345678",
  "timestamp": "YYYY-MM-DDTHH:MM:SS.000Z",
  "account_id": 1234,
  "transactions": [
    {
      "id": "transaction id here",
      "timestamp": "transaction timestamp here",
      "amount_instructed": 9.99,
      "amount_actual": 9.99,
      "currency": "GBP",
      "credit": false,
      "reference": "sender's reference",
      "bank_name": "",
      "bank_country": "",
      "account_name": "beneficiary name",
      "account_number": "beneficiary account number if available",
      "account_address": "",
      "sort_code": "beneficiary's UK sort code if applicable",
      "iban": "beneficiary's IBAN if available",
      "notes_external": "",
      "to": "beneficiary name"
    }
  ]
}

Status Notification Example

{
  "nonce": "xxxxx",
  "endToEndId": "xxxxxx",
  "transactionId": "xxxxxx",
  "status": "complete / Processing / Vop Help / Rejected"
}

Viban Success Notification Example

{
  "correlation_id": "xxxxxx",
  "segregated_account_id": xxxx,
  "request_details": {
    "owner_name": "Cust Name",
    "is_individual": true,
    "owner_address_line_1": "Address",
    "owner_city": "City",
    "owner_postcode": "12345",
    "owner_country": "ZA",
    "owner_nationality": "ZA",
    "owner_date_of_birth": "1990-01-01"
  },
  "account_details": {
    "iban": "xxxxxxx",
    "account_number": "xxxxxx",
    "bic": "xxxxx"
  }
}

Viban Closure Notification Example

{
  "segregated_account_id": "xxxx",
  "status": "CLOSED",
  "details": {
    "correlation_id": "xxxxxx",
    "account_details": {
      "account_number": "xxxxxx",
      "sort_code": "xxxxx",
      "iban": "xxxxxxx",
      "bic": "xxxxx"
    },
    "request_details": {
      "owner_name": "Name",
      "is_individual": true,
      "owner_address_line_1": "Address",
      "owner_city": "City",
      "owner_postcode": "xxxx",
      "owner_country": "ZA",
      "owner_nationality": "ZA",
      "owner_date_of_birth": "1990-01-01"
    }
  }
}