Guides

Open Banking Consents

Suggest Edits

Get an Open Banking Consent

There are 2 path parameters that this endpoint expects:

  1. countryCode: Alpha2 code of the country. (Currently, only 'GB' is supported)
  2. id: Id of the consent

Example responses for: GET /open-banking/{countryCode}/consents/{id} 

{
	"workflow": {},
	"data": {
		"consent": {
			"id": "00000000-0000-0000-0000-000000000000",
			"thirdPartyProvider": {
				"name": "Example TPP Company Limited",
				"website": "https://example.com",
				"applicationName": "Example Third Party Application",
				"applicationDescription": "Test harness app for integration environment",
				"applicationWebsite": "https://example.com"
			},
			"status": "authorised",
			"content": {
				"scope": "accounts"
			},
			"requestCreatedDateTime": "2023-05-11T09:17:59",
			"requestExpiryDateTime": "2023-05-11T09:27:59",
			"grantedDateTime": "2023-05-11T09:18:53",
			"expiryDateTime": "2023-08-09T09:18:53"
		}
	},
	"connect": {},
	"metadata": {}
}

{
	"workflow": {},
	"data": {
		"consent": {
			"id": "00000000-0000-0000-0000-000000000000",
			"thirdPartyProvider": {
				"name": "Example TPP Company Limited",
				"website": "https://example.com",
				"applicationName": "Example Third Party Application",
				"applicationDescription": "Test harness app for integration environment",
				"applicationWebsite": "https://example.com"
			},
			"status": "authorised",
			"content": {
				"scope": "payments",
				"paymentScope": "domestic",
				"paymentType": "standard",
				"instructedAmount": 10.25,
				"instructedCurrency": "GBP",
				"creditorAccount": {
					"schemeName": "UK.OBIE.SortCodeAccountNumber",
					"identification": "12345612345678",
					"name": "John Doe"
				},
				"currencyOfTransfer": null,
				"requestedExecutionDateTime": null
			},
			"requestCreatedDateTime": "2023-05-11T09:26:16",
			"grantedDateTime": "2023-05-11T09:27:21",
			"expiryDateTime": "2023-08-09T09:27:21"
		}
	},
	"connect": {},
	"metadata": {}
}

{
	"workflow": {},
	"data": {
		"consent": {
			"id": "00000000-0000-0000-0000-000000000000",
			"thirdPartyProvider": {
				"name": "Example TPP Company Limited",
				"website": "https://example.com",
				"applicationName": "Example Third Party Application",
				"applicationDescription": "Test harness app for integration environment",
				"applicationWebsite": "https://example.com"
			},
			"status": "authorised",
			"content": {
				"scope": "payments",
				"paymentScope": "domestic",
				"paymentType": "standard",
				"instructedAmount": 10.25,
				"instructedCurrency": "GBP",
				"creditorAccount": {
					"schemeName": "UK.OBIE.SortCodeAccountNumber",
					"identification": "12345612345678",
					"name": "John Doe"
				},
				"currencyOfTransfer": null,
				"requestedExecutionDateTime": null
			},
			"requestCreatedDateTime": "2023-05-11T09:26:16",
			"grantedDateTime": "2023-05-11T09:27:21",
			"expiryDateTime": "2023-08-09T09:27:21"
		}
	},
	"connect": {},
	"metadata": {}
}

{
	"workflow": {},
	"data": {
		"consent": {
			"id": "00000000-0000-0000-0000-000000000000",
			"thirdPartyProvider": {
				"name": "Example TPP Company Limited",
				"website": "https://example.com",
				"applicationName": "Example Third Party Application",
				"applicationDescription": "Test harness app for integration environment",
				"applicationWebsite": "https://example.com"
			},
			"status": "authorised",
			"content": {
				"scope": "payments",
				"paymentScope": "international",
				"paymentType": "standard",
				"instructedAmount": 10.25,
				"instructedCurrency": "GBP",
				"creditorAccount": {
					"schemeName": "UK.OBIE.IBAN",
					"identification": "GB12AB01234567890",
					"name": "John Doe"
				},
				"currencyOfTransfer": "EUR",
				"requestedExecutionDateTime": null
			},
			"requestCreatedDateTime": "2023-05-11T09:39:39",
			"grantedDateTime": "2023-05-11T09:40:25",
			"expiryDateTime": "2023-08-09T09:40:25"
		}
	},
	"connect": {},
	"metadata": {}
}

{
	"workflow": {},
	"data": {
		"consent": {
			"id": "00000000-0000-0000-0000-000000000000",
			"thirdPartyProvider": {
				"name": "Example TPP Company Limited",
				"website": "https://example.com",
				"applicationName": "Example Third Party Application",
				"applicationDescription": "Test harness app for integration environment",
				"applicationWebsite": "https://example.com"
			},
			"status": "authorised",
			"content": {
				"scope": "payments",
				"paymentScope": "international",
				"paymentType": "scheduled",
				"instructedAmount": 10.25,
				"instructedCurrency": "GBP",
				"creditorAccount": {
					"schemeName": "UK.OBIE.IBAN",
					"identification": "GB12AB01234567890",
					"name": "John Doe"
				},
				"currencyOfTransfer": "EUR",
				"requestedExecutionDateTime": "2023-06-11T11:54:49"
			},
			"requestCreatedDateTime": "2023-05-11T09:55:05",
			"grantedDateTime": "2023-05-11T09:55:44",
			"expiryDateTime": "2023-08-09T09:55:44"
		}
	},
	"connect": {},
	"metadata": {}
}

Approve An Open Banking Consent

PATCH /open-banking/{countryCode}/consents/{id}

Required parameters :

  • workflow.code --> Should be 'direct'
  • data.accountOpenBankingConsent.consentId --> Consent Id
  • data.accountOpenBankingConsent.action --> 'approve' or 'reject'
  • data.accountOpenBankingConsent.userId --> A unique Id for your account holder. Required if the status is "approve".
  • data.accountOpenBankingConsent.accounts --> An array of AccountIds. Required if the status is "approve".
{
  "workflow": {
    "code": "direct"
  },
  "data": {
    "consent": {
        "action": "approve",
        "userId": "00000000-0000-0000-0000-000000000000",
        "accounts": ["00000000-0000-0000-0000-000000000000", "00000000-0000-0000-0000-000000000001"]
    }
  },
  "connect": {},
  "metadata": {}
}

{
    "workflow": {
        "code": "direct"
    },
    "data": {
        "resource": {
            "location": "https://tell.systems/gateway/harness_return#code=55317927-5e32-49da-bbce-6b85ff05b88d&state=898a7c43-f52f-4728-9012-4599433d8372&id_token=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlgtSURWUi02MTk5Ny1ISFQifQ.eyJzdWIiOiJiOGEyZTdlNDFmNjY0N2YxYTVlM2I2NzIzYTM0MTliYSIsImF1ZCI6IjhkNWJmNGEyLTFmMWMtNDVhNy05YThlLWJkYTI1NmRkNzk2OCIsImV4cCI6MTY4NDkzNTU1NywiaWF0IjoxNjg0OTMxOTU3LCJhdXRoX3RpbWUiOjE2ODQ5MzE5NTcsIm5vbmNlIjoiYjEzZjlmMWQtNTFkYy00MTdmLWI5YjItOWIxNTIzOGMzNjk0Iiwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjoiNTUzMTc5MjctNWUzMi00OWRhLWJiY2UtNmI4NWZmMDViODhkIn0.yDrhNU9WM6YSC_zViiLlxlcG7BzbjfzMKA11SEZO2qOL1XJn3RTR9AsNQZfJSiTVHBL0t0KN51GpCL7W2Hy0ROT24K6GQvHz-3I9iRLdMxYoMfrNGvnZkGE3uUJTL8LvwRKxrmwCc_2FJOTAo6lgqg4XOttyDtoK4G6wFt4zAhKLYZbZIFtrT7Z831eU3GuONZJ0d2SADGpTzLHIq4EefZStVUiIKPBBh-nhnIAa5skXn5NmlSHr1GIwlS40Vo3MRcJTHBI-fF4zFL16-THgOrk5wkVdzeyvOyN2OHs4zTutcU6TCJnmMM_wYEINA31UP2fj_cl3oZmokmrrF7lA1P9KPSRMy5AjJSJViY9A09s1g4k09LZ2vVtFLcvMdvJugYBlL7MKn9pIw6JKEZRM5J1DOhD6THXYSGindI856oyvFD0brkQRrTrvIUQymrNtwjIHJM87BX_sHe9O29MQ2wsq0dnqUACD4WFA9KMu9DjpAu_qAF0Cq0WTVtPk2--oervOPCUavKXaw_X1GA6WUwfZT5bEEddNNIVr2tBFbUyVoj48v4Q5wZ7SXGTSOfaVslAHTS6e26iNZJbrz4wdiZApqsslRuX4CJsNzoTkLfztbI_P5clRqQvs9SHyr7pHV8YU76uUxKw0qTCz3l3V-w9RxZ3u8zLpRVcdBM9b7gg"
        }
    },
    "connect": {},
    "metadata": {}
}

Reject An Open Banking Consent

PATCH /open-banking/{countryCode}/consents/{id}

Required parameters :

  • workflow.code --> Should be 'direct'
  • data.accountOpenBankingConsent.consentId --> Consent Id
  • data.accountOpenBankingConsent.action --> 'approve' or 'reject'
  • data.accountOpenBankingConsent.userId --> A unique Id for your account holder. Required if the status is "approve".
  • data.accountOpenBankingConsent.accounts --> An array of AccountIds. Required if the status is "approve".
{
  "workflow": {
    "code": "direct"
  },
  "data": {
    "consent": {
        "action": "reject"
    }
  },
  "connect": {},
  "metadata": {}
}

{
    "workflow": {
        "code": "direct"
    },
    "data": {
        "resource": {
            "location": "https://tell.systems/gateway/harness_return#code=f979dd59-6653-40e1-aa23-6792d2e5e7c2&state=1cd14353-dcd7-40d3-a795-4b5442bccdf3&id_token=eyJhbGciOiJQUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IlgtSURWUi02MTk5Ny1ISFQifQ.eyJzdWIiOiI0MzQxMGRiYmU5YzVmZTBhNmYxN2QyMzBjNDMzY2Y0ZCIsImF1ZCI6IjhkNWJmNGEyLTFmMWMtNDVhNy05YThlLWJkYTI1NmRkNzk2OCIsImV4cCI6MTY4NDkzNjAxOSwiaWF0IjoxNjg0OTMyNDE5LCJhdXRoX3RpbWUiOjE2ODQ5MzI0MTksIm5vbmNlIjoiY2FhNDdlYjItNzA1Yy00NTdmLTlhOTItMzI2NTM4ZjNjNGNlIiwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjoiZjk3OWRkNTktNjY1My00MGUxLWFhMjMtNjc5MmQyZTVlN2MyIn0.M8EzKJPewojxaLQvFxDoNpRNxheH4q9nx1aBvzebjrxcqt-_vsfVX0jqL3K5uwKykjbm_weoaa6RvrD1gHoQL7_QDeCRcoZygBXVuC2TwbwzTZBYWFeOaF_m8yd-dGNTJkgyTnPYj2A24uFPFda7ZPEe-SO9LH4JZxgjjM0UEpl2dqra_YMVwxL-QZcC4uOUKoJJhEM-4rVVy0ArlMT4KXLukehcw8JIAPP3PLDFnyBoNvt4WqmAUeoHp78iqWHYTl77Qbb2sw6o-keRaqB3rYuJ1l1XJabqooEvFTDUDtnpzyt_fFVXMcBD4svltM0UXacMEB5Z6ZH6PhtevZ-gwSRzXex5xB0OPXDqbm1XjQzwEdlkdaeTx_1819TM15bYyztiMHgQMGTi7JxljU2NM-VRNsHnP3gxWElFEDdEEZUet7PBGCP9fLpZjk2r1iN7IxRZt8ah-6SRMvWvNqrY76_F0REx0WyO2JmcHbQImQSj8h6Fq8YmsAIEBCvBVshpUaMpR79rcQK4CDMN_A7CV-pK4B73FdsTUztbkE7UXi-r3tkCQ9jQJxG1y90j8CyBhje0HQFlGHRsmiWolwlxCHWaZhUvBWoj6IGrb5Hr1XwoUPpDblMIu6CU4CHN0p7P9VGEBxA_hv9olc7rDFH2gmPZP6V3wx66ei_xDmbDlmE"
        }
    },
    "connect": {},
    "metadata": {}
}

List Open Banking Consents

GET/open-banking/{countryCode}/consents `

Supported query parameters:

data.consent.userIdId of user
workflow.codeType of consent creation workflow
(direct)
{
	"workflow": {
		"code": "direct"
	},
	"data": {
		"consents": [{
			"id": "00000000-0000-0000-0000-000000000000",
			"thirdPartyProvider": {
				"name": "Example TPP Company Limited",
				"website": "https://example.com",
				"applicationName": "Example Third Party Application",
				"applicationDescription": "Test harness app for integration environment",
				"applicationWebsite": "https://example.com"
			},
			"status": "awaiting-exchange",
			"content": {
				"scope": "accounts"
			},
			"requestCreatedDateTime": "2023-02-24T10:07:05",
			"requestExpiryDateTime": "2023-02-24T10:08:05"
		}]
	},
	"connect": {},
	"metadata": {}
}

Revoke An Open Banking Consent

PATCH /open-banking/{countryCode}/consents/{id}

Required parameters :

  • workflow.code --> Should be 'direct'
  • data.accountOpenBankingConsent.consentId --> Consent Id
  • data.accountOpenBankingConsent.action --> 'approve' or 'reject'
  • data.accountOpenBankingConsent.userId --> A unique Id for your account holder. Required if the status is "approve".
  • data.accountOpenBankingConsent.accounts --> An array of AccountIds. Required if the status is "approve".
{
  "workflow": {
    "code": "direct"
  },
  "data": {
    "consent": {
        "action": "revoke"   
    }
  },
  "connect": {},
  "metadata": {}
}

{
	"workflow": {
		"code": "direct"
	},
	"data": {
		"resource": {
			"consent": {
				"id": "cb821c9e-2c90-4569-80d0-88f7272428cd",
				"thirdPartyProvider": {
					"name": "Example TPP Company Limited",
					"website": "https://example.com",
					"applicationName": "Example Third Party Application",
					"applicationDescription": "Test harness app for integration environment",
					"applicationWebsite": "https://example.com"
				},
				"status": "revoked",
				"content": {
					"scope": "accounts"
				},
				"requestCreatedDateTime": "2023-05-24T13:18:45",
				"requestExpiryDateTime": "2023-05-24T13:28:45"
			}
		}
	},
	"connect": {},
	"metadata": {}
}

Updated 6 months ago