deprecated
Release Notes for Plug-In Account Connections: 26/02/2024
10 months ago
This release includes API changes to the Account API. Below, you'll find details about the modifications included in this release.
Account API changes:
- On account issue creation, an account can have built-in or plug-in connect methods. Account Create API. This common method field is optional and all methods are possible. The default method value is "built-in" which means creating an integrated service provider account to IF. Also, there is another method value called "plug-in". The plug-in method is for creating non-integrated service provider accounts to IF. If a connect method is not set when creating an account, it defaults to "built-in". If the connect method is "plug-in" then connect type must be "explicit" and if the connect method is "built-in" then connect type can be "implicit" or "explicit".
{
"workflow":{
"code":"client.issuing"
},
"data":{
"account":{
"clientId":"00000000-0000-0000-0000-000000000000",
"currency":"EUR",
"alias":"EUR Account"
}
},
"connect":{
"method":"built-in",
"type":"explicit",
"serviceProvider":"railsbank"
},
"metadata":{
}
}
{
"workflow":{
"code":"client.issuing"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"pending",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account",
"routingCodes":{
},
"iban":null,
"accountNumber":null,
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":"railsbank",
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection":{
"id":null,
"method":"built-in",
"serviceProvider":"railsbank",
"reference":null,
"state":"creation-in-progress",
"status":null,
"error":null
}
}
},
"connect":{
"method":"built-in",
"type":"explicit",
"serviceProvider":"railsbank"
},
"metadata":{}
}
{
"workflow":{
"code":"client.issuing"
},
"data":{
"account":{
"clientId":"00000000-0000-0000-0000-000000000000",
"currency":"EUR",
"alias":"EUR Account"
}
},
"connect":{
"type":"explicit",
"serviceProvider":"railsbank"
},
"metadata":{}
}
{
"workflow":{
"code":"client.issuing"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"pending",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account",
"routingCodes":{
},
"iban":null,
"accountNumber":null,
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":"railsbank",
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection":{
"id":null,
"method":"built-in",
"serviceProvider":"railsbank",
"reference":null,
"state":"creation-in-progress",
"status":null,
"error":null
}
}
},
"connect":{
"method":"built-in",
"type":"explicit",
"serviceProvider":"railsbank"
},
"metadata":{
}
}
{
"workflow":{
"code":"client.issuing"
},
"data":{
"account":{
"clientId":"00000000-0000-0000-0000-000000000000",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account"
}
},
"connect":{
"method":"plug-in",
"type": "explicit",
"serviceProvider":"revolut"
},
"metadata":{
}
}
{
"workflow":{
"code":"client.issuing"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"pending",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account",
"routingCodes":{
},
"iban":null,
"accountNumber":null,
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":null,
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection": {
"id":null,
"method":"plug-in",
"serviceProvider":"revolut",
"reference":null,
"state":"creation-in-progress",
"status":null,
"error":null
}
}
},
"connect":{
"method":"plug-in",
"type": "explicit",
"serviceProvider":"revolut",
},
"metadata":{}
}
- On account migration creation, an account connect method can have built-in or empty values Account Create API. This connect method field can not be plug-in value because migration is allowed only for integrated service providers. In addition to this, connect type can be "implicit" or "explicit".
{
"workflow":{
"code":"client.migration"
},
"data":{
"account":{
"clientId":"00000000-0000-0000-0000-000000000000",
"currency":"EUR",
"alias":"EUR Account"
},
"sourceId":"00000000-0000-0000-0000-000000000000"
},
"connect":{
"type":"explicit",
"serviceProvider":"railsbank"
},
"metadata":{
}
}
{
"workflow":{
"code":"client.migration"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"active",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account",
"routingCodes":{
},
"iban":null,
"accountNumber":null,
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":"railsbank",
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"method":"built-in",
"serviceProvider":"railsbank",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"active",
"error":null
}
}
},
"connect":{
"method":"built-in",
"type":"explicit",
"serviceProvider":"railsbank"
},
"metadata":{}
}
{
"workflow":{
"code":"client.migration"
},
"data":{
"account":{
"clientId":"00000000-0000-0000-0000-000000000000",
"currency":"EUR",
"alias":"EUR Account"
},
"sourceId":"00000000-0000-0000-0000-000000000000"
},
"connect":{
"method":"built-in",
"type":"explicit",
"serviceProvider":"railsbank"
},
"metadata":{
}
}
{
"workflow":{
"code":"client.migration"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"active",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account",
"routingCodes":{
},
"iban":null,
"accountNumber":null,
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":"railsbank",
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"method":"built-in",
"serviceProvider":"railsbank",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"active",
"error":null
}
}
},
"connect":{
"method":"built-in",
"type":"explicit",
"serviceProvider":"railsbank"
},
"metadata":{
}
}
- On sub-account creation, there are no fields on the connect object. The sub-account gets the service provider from the connected main account. Account Create API
{
"workflow":{
"code":"client.sub-account"
},
"data":{
"account":{
"clientId":"00000000-0000-0000-0000-000000000000",
"currency":"EUR",
"alias":"EUR Account",
"mainAccountId":"00000000-0000-0000-0000-000000000000"
}
},
"connect":{
},
"metadata":{
}
}
{
"workflow":{
"code":"client.sub-account"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"pending",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account",
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":null,
"mainAccountId":"00000000-0000-0000-0000-000000000000",
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual"
}
},
"connect":{
},
"metadata":{
}
}
- On account updating, the "plug-in" connect method created accounts must be updated with the connection object, and the "built-in" connect method created accounts must be updated without the connection object Account Update API.
{
"workflow":{
"code":"client.direct"
},
"data":{
"account":{
"alias":"EUR Account 2",
"status":"closed"
}
},
"connect": {},
"metadata":{}
}
{
"workflow": {
"code": "client.direct"
},
"data": {
"account": {
"id": "00000000-0000-0000-0000-000000000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"status": "closed",
"country": "GB",
"currency": "EUR",
"alias": "EUR Account 2",
"routingCodes": {},
"iban": null,
"accountNumber": null,
"ledgerNumber": "12345678",
"availableBalance": 0,
"receivableBalance": 0.00,
"mainAccountId": null,
"serviceProvider": "railsbank",
"accountHolderName": "Sherlock Holmes",
"accountHolderIdentityType": "individual",
"connection": {
"id":"00000000-0000-0000-0000-000000000000",
"method": "built-in",
"serviceProvider": "railsbank",
"reference": "00000000-0000-0000-0000-000000000000",
"state": "completed-up-to-date",
"status": "active",
"error": null
}
}
},
"connect": {
},
"metadata": {}
}
{
"workflow":{
"code":"client.direct"
},
"data":{
"account":{
"accountNumber":"12345678",
"iban":"GB85LOYD77913045276224",
"routingCodes":{
"sort-code":"123456"
},
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"active"
}
}
},
"connect":{
},
"metadata":{
}
}
{
"workflow":{
"code":"client.direct"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"active",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account",
"accountNumber":"12345678",
"iban":"GB85LOYD77913045276224",
"routingCodes":{
"sort-code":"123456"
},
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":null,
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"method":"plug-in",
"serviceProvider":"revolut",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"active",
"error":null
}
}
},
"connect":{
},
"metadata":{
}
}
{
"workflow":{
"code":"client.direct"
},
"data":{
"account": {
"connection":{
"state":"creation-failed",
"error":{
"category": "functional/technical",
"origin": "customer/platform/provider",
"code":"..free text..",
"message":"..free text..",
"attributes":{
"key01": "value01",
"key02": "value02"
}
}
}
}
},
"connect":{
},
"metadata":{
}
}
{
"workflow":{
"code":"client.direct"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"pending",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account",
"routingCodes":{
},
"iban":null,
"accountNumber":null,
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":null,
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection":{
"id":null,
"method":"plug-in",
"serviceProvider":"revolut",
"reference":null,
"state":"creation-failed",
"status":null,
"error":{
"category": "functional/technical",
"origin": "customer/platform/provider",
"code":"..free text..",
"message":"..free text..",
"attributes":{
"key01": "value01",
"key02": "value02"
}
}
}
}
},
"connect":{
},
"metadata":{}
}
{
"workflow":{
"code":"client.direct"
},
"data":{
"account":{
"status":"declined",
"connection":{
"state":"creation-failed",
"error":{
"category": "functional/technical",
"origin": "customer/platform/provider",
"code":"..free text..",
"message":"..free text..",
"attributes":{
"key01": "value01",
"key02": "value02"
}
}
}
}
},
"connect":{
},
"metadata":{
}
}
{
"workflow":{
"code":"client.direct"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"declined",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account",
"routingCodes":{
},
"iban":null,
"accountNumber":null,
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":null,
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection":{
"id":null,
"method":"plug-in",
"serviceProvider":"revolut",
"reference":null,
"state":"creation-failed",
"status":null,
"error":{
"category": "functional/technical",
"origin": "customer/platform/provider",
"code":"..free text..",
"message":"..free text..",
"attributes":{
"key01": "value01",
"key02": "value02"
}
}
}
}
},
"connect":{
},
"metadata":{
}
}
- Added connection to the Account Get API "data.account" JSON object Account Get API. Also "connect.connection" object is DEPRECATED and will be removed on 30/05/2024.
GET /accounts/{accountId}?metadata.include=connect.connection
{
"workflow": {},
"data": {
"account": {
"id": "00000000-0000-0000-0000-000000000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"status": "active",
"country": "GB",
"currency": "EUR",
"alias": "EUR Account",
"routingCodes": {},
"iban": null,
"accountNumber": null,
"ledgerNumber": "12345678",
"availableBalance": 0,
"serviceProvider": "railsbank",
"accountHolderName": "Sherlock Holmes",
"accountHolderIdentityType": "individual",
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"method": "built-in",
"serviceProvider": "railsbank",
"reference": "00000000-0000-0000-0000-000000000000",
"state": "completed-up-to-date",
"status": "active",
"reason": null
}
}
},
"connect": {
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"serviceProvider": "railsbank",
"reference": "00000000-0000-0000-0000-000000000000",
"state": "completed-up-to-date",
"status": "active",
"reason": null
}
},
"metadata": {
"include": [
"connect.connection"
]
}
}
{
"workflow":{
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"mainAccountId":"00000000-0000-0000-0000-000000000000",
"status":"active",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account",
"routingCodes":{
},
"iban":null,
"accountNumber":null,
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":"railsbank",
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual"
}
},
"connect":{
},
"metadata":{
}
}
{
"workflow": {},
"data": {
"account": {
"id": "00000000-0000-0000-0000-000000000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"status": "active",
"country": "GB",
"currency": "EUR",
"alias": "EUR Account",
"routingCodes": {},
"iban": null,
"accountNumber": null,
"ledgerNumber": "12345678",
"availableBalance": 0,
"serviceProvider": "revolut",
"accountHolderName": "Sherlock Holmes",
"accountHolderIdentityType": "individual",
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"method": "plug-in",
"serviceProvider": "revolut",
"reference": "00000000-0000-0000-0000-000000000000",
"state": "completed-up-to-date",
"status": "active",
"reason": null
}
}
},
"connect": {
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"serviceProvider": "revolut",
"reference": "00000000-0000-0000-0000-000000000000",
"state": "completed-up-to-date",
"status": "active",
"reason": null
}
},
"metadata": {}
}
{
"workflow":{
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"mainAccountId":"00000000-0000-0000-0000-000000000000",
"status":"active",
"country":"GB",
"currency":"EUR",
"alias":"EUR Account",
"routingCodes":{
},
"iban":null,
"accountNumber":null,
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":"revolut",
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual"
}
},
"connect":{
},
"metadata":{
}
}
GET /accounts/{accountId}?metadata.expand=data.account.clientId
{
"workflow": {},
"data": {
"account": {
"id": "00000000-0000-0000-0000-000000000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"status": "active",
"country": "GB",
"currency": "GBP",
"alias": "test 1",
"routingCodes": {},
"iban": null,
"accountNumber": null,
"ledgerNumber": "43611883",
"availableBalance": 0.00,
"receivableBalance": 0.00,
"accountHolderIdentityType": "individual",
"accountHolderName": "car keyboard",
"mainAccountId": null,
"serviceProvider": "nium",
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"method": "built-in",
"serviceProvider": "railsbank",
"reference": "00000000-0000-0000-0000-000000000000",
"state": "completed-up-to-date",
"status": "active",
"reason": null
}
},
"client": {
"id": "00000000-0000-0000-0000-000000000000",
"clientNumber": "23050065",
"fullName": "car keyboard",
"status": "active",
"identity": {
"type": "individual",
"country": "GB",
"identifications": [
{
"type": "identity-card",
"identificationNumber": "12345677",
"issuingCountry": "GB",
"issueDate": "2022-01-01",
"expirationDate": "2032-01-01"
}
],
"givenName": "car",
"familyName": "keyboard",
"birthDate": "1953-01-06"
}
}
},
"connect": {},
"metadata": {
"expand": [
"data.account.clientId"
]
}
}
{
"workflow": {},
"data": {
"account": {
"id": "00000000-0000-0000-0000-000000000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"status": "active",
"country": "GB",
"currency": "GBP",
"alias": "test 1",
"routingCodes": {},
"iban": null,
"accountNumber": null,
"ledgerNumber": "43611883",
"availableBalance": 0.00,
"receivableBalance": 0.00,
"accountHolderIdentityType": "individual",
"accountHolderName": "car keyboard",
"mainAccountId": null,
"serviceProvider": "nium",
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"method": "plug-in",
"serviceProvider": "revolut",
"reference": "00000000-0000-0000-0000-000000000000",
"state": "completed-up-to-date",
"status": "active",
"reason": null
}
},
"client": {
"id": "00000000-0000-0000-0000-000000000000",
"clientNumber": "23050065",
"fullName": "car keyboard",
"status": "active",
"identity": {
"type": "individual",
"country": "GB",
"identifications": [
{
"type": "identity-card",
"identificationNumber": "12345677",
"issuingCountry": "GB",
"issueDate": "2022-01-01",
"expirationDate": "2032-01-01"
}
],
"givenName": "car",
"familyName": "keyboard",
"birthDate": "1953-01-06"
}
}
},
"connect": {},
"metadata": {
"include": [
"data.account.clientId"
]
}
}
- Added connection JSON object to the Account List API "data.accounts" JSON objects Account List API.
{
"workflow": {},
"data": {
"accounts": [
{
"id": "00000000-0000-0000-0000-000000000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"status": "pending",
"country": "GB",
"currency": "EUR",
"alias": "EUR Account",
"routingCodes": {},
"iban": null,
"accountNumber": null,
"ledgerNumber": "12345678",
"availableBalance": 0,
"receivableBalance": 0.00,
"serviceProvider": "railsbank",
"accountHolderName": "Sherlock Holmes",
"accountHolderIdentityType": "individual",
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"method": "built-in",
"serviceProvider": "railsbank",
"reference": "00000000-0000-0000-0000-000000000000",
"state": "completed-up-to-date",
"status": "active",
"reason": null
}
},
{
"id": "00000000-0000-0000-0000-000000000000",
"clientId": "00000000-0000-0000-0000-000000000000",
"mainAccountId": "00000000-0000-0000-0000-000000000000",
"status": "pending",
"country": "GB",
"currency": "EUR",
"alias": "EUR Account",
"routingCodes": {},
"iban": null,
"accountNumber": null,
"ledgerNumber": "12345678",
"availableBalance": 0,
"receivableBalance": 0.00,
"serviceProvider": "revolut",
"accountHolderName": "Sherlock Holmes",
"accountHolderIdentityType": "individual",
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"method": "plug-in",
"serviceProvider": "revolut",
"reference": "00000000-0000-0000-0000-000000000000",
"state": "completed-up-to-date",
"status": "active",
"reason": null
}
}
]
},
"connect": {},
"metadata": {
"page": {
"size": 10,
"totalElements": 100,
"totalPages": 10,
"number": 0
}
}
}
- Added connection JSON object to the Account Webhooks "data.account" JSON object Account Webhooks. Also "connect.connection" object is DEPRECATED and will be removed on 30/05/2024.
{
"webhook":{
"module":"accounts",
"type":"account-activated"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"active",
"country":"GB",
"currency":"GBP",
"alias":"GBP Account",
"routingCodes":{
"sort-code":"123456"
},
"iban":null,
"accountNumber":"12345678",
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":"railsbank",
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"method":"built-in",
"serviceProvider":"railsbank",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"active",
"reason":null
}
}
},
"connect":{
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"serviceProvider":"railsbank",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"active",
"reason":null
}
},
"metadata":{
}
}
{
"webhook":{
"module":"accounts",
"type":"account-activated"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"active",
"country":"GB",
"currency":"GBP",
"alias":"GBP Account",
"routingCodes":{
"sort-code":"123456"
},
"iban":null,
"accountNumber":"12345678",
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":"revolut",
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"method":"plug-in",
"serviceProvider":"revolut",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"active",
"reason":null
}
}
},
"connect":{
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"serviceProvider":"revolut",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"active",
"reason":null
}
},
"metadata":{
}
}
{
"webhook":{
"module":"accounts",
"type":"account-inactivated"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"inactive",
"country":"GB",
"currency":"GBP",
"alias":"GBP Account",
"routingCodes":{
"sort-code":"123456"
},
"iban":null,
"accountNumber":"12345678",
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":"railsbank",
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"method":"built-in",
"serviceProvider":"railsbank",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"active",
"reason":null
}
}
},
"connect":{
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"serviceProvider":"railsbank",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"active",
"reason":null
}
},
"metadata":{
}
}
{
"webhook":{
"module":"accounts",
"type":"account-inactivated"
},
"data":{
"account":{
"id":"00000000-0000-0000-0000-000000000000",
"clientId":"00000000-0000-0000-0000-000000000000",
"status":"inactive",
"country":"GB",
"currency":"GBP",
"alias":"GBP Account",
"routingCodes":{
"sort-code":"123456"
},
"iban":null,
"accountNumber":"12345678",
"ledgerNumber":"12345678",
"availableBalance":0,
"serviceProvider":"revolut",
"accountHolderName":"Sherlock Holmes",
"accountHolderIdentityType":"individual",
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"method":"plug-in",
"serviceProvider":"revolut",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"inactive",
"reason":null
}
}
},
"connect":{
"connection":{
"id":"00000000-0000-0000-0000-000000000000",
"serviceProvider":"revolut",
"reference":"00000000-0000-0000-0000-000000000000",
"state":"completed-up-to-date",
"status":"inactive",
"reason":null
}
},
"metadata":{
}
}
-
Added Account Connection Webhooks Account Webhooks. There are 6 types of webhooks sent for account connections:
- connection-creation-instructed
- connection-created
- connection-creation-failed
- connection-update-instructed
- connection-updated
- connection-update-failed
These types are exposed in the webhook.type field. - "connect.connection" object is DEPRECATED and will be removed on 30/05/2024 because the connection object is added to "data.account" object.
{ "webhook":{ "module":"accounts", "type":"connection-created" }, "data":{ "account":{ "id":"00000000-0000-0000-0000-000000000000", "clientId":"00000000-0000-0000-0000-000000000000", "status":"active", "country":"GB", "currency":"GBP", "alias":"GBP Account", "routingCodes":{ "sort-code":"123456" }, "iban":null, "accountNumber":"12345678", "ledgerNumber":"12345678", "availableBalance":0, "serviceProvider":"railsbank", "accountHolderName":"Sherlock Holmes", "accountHolderIdentityType":"individual", "connection":{ "id":"00000000-0000-0000-0000-000000000000", "method":"built-in", "serviceProvider":"railsbank", "reference":"00000000-0000-0000-0000-000000000000", "state":"completed-up-to-date", "status":"active", "reason":null } } }, "connect":{ "connection":{ "id":"00000000-0000-0000-0000-000000000000", "serviceProvider":"railsbank", "reference":"00000000-0000-0000-0000-000000000000", "state":"completed-up-to-date", "status":"active", "reason":null } }, "metadata":{ } }{ "webhook":{ "module":"accounts", "type":"connection-updated" }, "data":{ "account":{ "id":"00000000-0000-0000-0000-000000000000", "clientId":"00000000-0000-0000-0000-000000000000", "status":"closed", "country":"GB", "currency":"GBP", "alias":"GBP Account", "routingCodes":{ "sort-code":"123456" }, "iban":null, "accountNumber":"12345678", "ledgerNumber":"12345678", "availableBalance":0, "serviceProvider":"railsbank", "accountHolderName":"Sherlock Holmes", "accountHolderIdentityType":"individual", "connection":{ "id":"00000000-0000-0000-0000-000000000000", "method":"built-in", "serviceProvider":"railsbank", "reference":"00000000-0000-0000-0000-000000000000", "state":"completed-up-to-date", "status":"closed", "reason":null } } }, "connect":{ "connection":{ "id":"00000000-0000-0000-0000-000000000000", "serviceProvider":"railsbank", "reference":"00000000-0000-0000-0000-000000000000", "state":"completed-up-to-date", "status":"closed", "reason":null } }, "metadata":{ } }{ "webhook":{ "module":"accounts", "type":"connection-created" }, "data":{ "account":{ "id":"00000000-0000-0000-0000-000000000000", "clientId":"00000000-0000-0000-0000-000000000000", "status":"active", "country":"GB", "currency":"GBP", "alias":"GBP Account", "routingCodes":{ "sort-code":"123456" }, "iban":null, "accountNumber":"12345678", "ledgerNumber":"12345678", "availableBalance":0, "serviceProvider":"revolut", "accountHolderName":"Sherlock Holmes", "accountHolderIdentityType":"individual", "connection":{ "id":"00000000-0000-0000-0000-000000000000", "method":"plug-in", "serviceProvider":"revolut", "reference":"00000000-0000-0000-0000-000000000000", "state":"completed-up-to-date", "status":"active", "reason":null } } }, "connect":{ "connection":{ "id":"00000000-0000-0000-0000-000000000000", "serviceProvider":"revolut", "reference":"00000000-0000-0000-0000-000000000000", "state":"completed-up-to-date", "status":"active", "reason":null } }, "metadata":{ } }{ "webhook":{ "module":"accounts", "type":"connection-updated" }, "data":{ "account":{ "id":"00000000-0000-0000-0000-000000000000", "clientId":"00000000-0000-0000-0000-000000000000", "status":"closed", "country":"GB", "currency":"GBP", "alias":"GBP Account", "routingCodes":{ "sort-code":"123456" }, "iban":null, "accountNumber":"12345678", "ledgerNumber":"12345678", "availableBalance":0, "serviceProvider":"revolut", "accountHolderName":"Sherlock Holmes", "accountHolderIdentityType":"individual", "connection":{ "id":"00000000-0000-0000-0000-000000000000", "method":"plug-in", "serviceProvider":"revolut", "reference":"00000000-0000-0000-0000-000000000000", "state":"completed-up-to-date", "status":"closed", "reason":null } } }, "connect":{ "connection":{ "id":"00000000-0000-0000-0000-000000000000", "serviceProvider":"revolut", "reference":"00000000-0000-0000-0000-000000000000", "state":"completed-up-to-date", "status":"closed", "reason":null } }, "metadata":{ } }