Constraints
Get Data Constraints Rules
Get Data Constraints Rules against an Institution for Account Authorisation requests
get/institutions/constraints/data
Request
- Base URLhttps://api.yapily.com
- AuthHTTP basic
Query parameters
institutionIdsstring[] required
Unique Id(s) of the Institution(s) to retrieve the Data Constraints for. Multiple institutionIds need to be separated by ,
institutionCountryCodestring required
Country code of the Institution(s). Ensure that the country code matches the respective institutionIds; any mismatch will result in an HTTP 404 error response.
endpointPathstring
The path on the API that is associated with the operation for which constraints are to be retrieved
endpointMethod'POST' | 'PATCH' | 'PUT' | 'GET' | 'DELETE'
The HTTP method that is associated with the operation for which constraints are to be retrieved
Response
Ok
Example response
{
"meta": {
"tracingId": "a43049c1dbc04d6f8c8e2dfdc523217a"
},
"data": [
{
"institutionId": "mock-sandbox",
"institutionCountryCode": "GB",
"endpointPath": "/account-auth-requests",
"endpointMethod": "POST",
"request": {
"headers": {
"title": "Header",
"type": "object",
"properties": {
"psuID": {
"title": "PSU Id",
"type": "string",
"description": "__Mandatory__. The psu id"
}
}
},
"body": {
"required": [
"institutionId"
],
"type": "object",
"properties": {
"userUuid": {
"title": "User UUID",
"type": "string",
"format": "uuid"
},
"institutionId": {
"title": "Institution Identifier",
"type": "string",
"description": "__Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to.",
"example": "yapily-mock"
},
"oneTimeToken": {
"title": "One Time Token",
"type": "boolean",
"description": "__Conditional__. Used to receive a `oneTimeToken` rather than a `consentToken` at the `callback` for additional security. This can only be used when the `callback` is set. \n\nSee [Using a callback with an OTT (Optional)](/open-banking-flow/handling-redirects/callback-url) for more information.",
"example": false
},
"callback": {
"title": "Callback",
"type": "string",
"description": "__Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`. \n\nSee [Using a callback (Optional)](/open-banking-flow/handling-redirects/callback-url) for more information.",
"example": "https://display-parameters.com"
},
"accountRequest": {
"title": "Account Request",
"type": "object",
"properties": {
"transactionFrom": {
"title": "Transaction From Date",
"type": "string",
"description": "__Optional__. Used to specify the lower bound on when to pull transaction. This should be declared when accessing transaction older than 90 days for banks in the [CBI Globe](/data/financial-data-resources/data-restrictions#cbi-globe-gateway).",
"format": "date-time"
},
"transactionTo": {
"title": "Transaction To Date",
"type": "string",
"description": "__Optional__. When performing a request using the consent, this is the latest date of transaction records that can be retrieved.",
"format": "date-time"
},
"expiresAt": {
"title": "Expires At",
"type": "string",
"description": "__Optional__. Used to set a hard date for when the user's associated `Consent` will expire.\n\n**Note**: If this supported by the bank, specifying this is property is opting out of having a long-lived consent that can be perpetually re-authorised by the user. This will add an `expiresAt` field on the `Consent` object which will render it unusable after this date.\n\n**Note**: This is not supported by every `Institution`. In such case, the request will not fail but the property will be ignored and the created `Consent` will not have an expiry date.",
"format": "date-time"
},
"accountIdentifiers": {
"title": "Account Info",
"required": [
"accountIdentification"
],
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "__Conditional__. Unique identifier of the account.",
"example": "500000000000000000000001"
},
"accountIdentification": {
"title": "Account Identifications",
"required": [
"identification",
"type"
],
"type": "object",
"properties": {
"type": {
"enum": [
"SORT_CODE",
"ACCOUNT_NUMBER",
"IBAN",
"BBAN",
"BIC",
"PAN",
"MASKED_PAN",
"MSISDN",
"BSB",
"NCC",
"ABA",
"ABA_WIRE",
"ABA_ACH",
"EMAIL",
"ROLL_NUMBER",
"BLZ",
"IFS",
"CLABE",
"CTN",
"BRANCH_CODE",
"VIRTUAL_ACCOUNT_ID"
],
"title": "Account Identification Type",
"type": "string",
"description": "__Mandatory__. Used to describe the format of the account.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on when to specify each type.",
"example": "SORT_CODE"
},
"identification": {
"title": "Account Identification",
"type": "string",
"description": "__Mandatory__. The value associated with the account identification type.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on the format of the values.",
"example": "401016"
}
}
}
},
"description": "__Conditional__. Used to create a request for the balance of the account specified. Once the user authorises the request, only the balance can be obtained by executing [GET Account Balances](./#get-account-balances).\n\n This can be specified in conjunction with `accountIdentifiersForTransaction` to generate a `Consent` that can both access the accounts balance and transactions."
},
"accountIdentifiersForTransaction": {
"type": "array",
"items": {
"required": [
"accountIdentification"
],
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "__Conditional__. Unique identifier of the account.",
"example": "500000000000000000000001"
},
"accountIdentification": {
"title": "Account Identifications",
"required": [
"identification",
"type"
],
"type": "object",
"properties": {
"type": {
"enum": [
"SORT_CODE",
"ACCOUNT_NUMBER",
"IBAN",
"BBAN",
"BIC",
"PAN",
"MASKED_PAN",
"MSISDN",
"BSB",
"NCC",
"ABA",
"ABA_WIRE",
"ABA_ACH",
"EMAIL",
"ROLL_NUMBER",
"BLZ",
"IFS",
"CLABE",
"CTN",
"BRANCH_CODE",
"VIRTUAL_ACCOUNT_ID"
],
"title": "Account Identification Type",
"type": "string",
"description": "__Mandatory__. Used to describe the format of the account.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on when to specify each type.",
"example": "SORT_CODE"
},
"identification": {
"title": "Account Identification",
"type": "string",
"description": "__Mandatory__. The value associated with the account identification type.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on the format of the values.",
"example": "401016"
}
}
}
}
},
"description": "__Conditional__. Used to create a request for the transactions of the account specified. Once the user authorises the request, only the transactions can be obtained by executing [GET Account Transactions](./#get-account-transactions). \n\nThis can be specified in conjunction with `accountIdentifiersForBalance` to generate a `Consent` that can both access the accounts balance and transactions."
},
"accountIdentifiersForBalance": {
"type": "array",
"items": {
"required": [
"accountIdentification"
],
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "__Conditional__. Unique identifier of the account.",
"example": "500000000000000000000001"
},
"accountIdentification": {
"title": "Account Identifications",
"required": [
"identification",
"type"
],
"type": "object",
"properties": {
"type": {
"enum": [
"SORT_CODE",
"ACCOUNT_NUMBER",
"IBAN",
"BBAN",
"BIC",
"PAN",
"MASKED_PAN",
"MSISDN",
"BSB",
"NCC",
"ABA",
"ABA_WIRE",
"ABA_ACH",
"EMAIL",
"ROLL_NUMBER",
"BLZ",
"IFS",
"CLABE",
"CTN",
"BRANCH_CODE",
"VIRTUAL_ACCOUNT_ID"
],
"title": "Account Identification Type",
"type": "string",
"description": "__Mandatory__. Used to describe the format of the account.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on when to specify each type.",
"example": "SORT_CODE"
},
"identification": {
"title": "Account Identification",
"type": "string",
"description": "__Mandatory__. The value associated with the account identification type.\n\n See [Account Identification Combinations](/payments/payment-resources/intro-to-payment-execution#account-identifications-combinations) for more information on the format of the values.",
"example": "401016"
}
}
}
}
},
"description": "__Conditional__. Used to create a request for the transactions of the account specified. Once the user authorises the request, only the transactions can be obtained by executing [GET Account Transactions](./#get-account-transactions). \n\nThis can be specified in conjunction with `accountIdentifiersForBalance` to generate a `Consent` that can both access the accounts balance and transactions."
},
"featureScope": {
"title": "Feature Scope",
"type": "array",
"items": {
"type": "string"
},
"description": "Used to describe what functions are supported by the associated `Institution`"
}
},
"description": "Account authorisation request schema"
}
},
"description": "The request body containing an `AccountAuthorisationRequest` json payload"
}
}
}
]
}Changes
No recorded changes to this operation across all 4 revisions of this API.