Download OpenAPI specification:Download
The Yapily API enables connections between your application and users' banks. For more information check out our documentation.
In particular, make sure to view our Getting Started steps if this is your first time here.
While testing the API, our list of sandbox credentials maybe useful.
Requests to the Yapily API are authenticated using an Application's APPLICATION_KEY
and APPLICATION_SECRET
. You can view and manage your credentials in the Yapily Console.
An APPLICATION_KEY
and APPLICATION_SECRET
pair provides connectivity to each Institution
configured in a Yapily Application
, so it is important to keep these credentials secure. Do not share your APPLICATION_SECRET
in publicly accessible areas such as GitHub, client-side code, etc.
Authentication is performed using HTTP Basic Authentication. Your APPLICATION_KEY
should be sent as the basic auth username
and your APPLICATION_SECRET
should be sent as the basic auth password
.
All requests should be made via HTTPS.
Security Scheme Type | HTTP |
---|---|
HTTP Authorization Scheme | basic |
The Application
is the base entity that is used to interact with the API and contains a collection of Institution
objects. You can have multiple Applications associated with your account e.g. a production application with live access to each Institution
and a development application with access to sandboxes.
Get the information about the institutions configured in your application
Ok
Error Response
curl -i -X GET \ -u <username>:<password> \ https://api.yapily.com/me
Example Response
{- "uuid": "64949de6-6510-4d70-9500-d4aa094c506c",
- "name": "APPLICATION NAME",
- "active": true,
- "institutions": [
- {
- "id": "modelo-sandbox",
- "name": "Modelo Sandbox",
- "fullName": "Modelo Sandbox",
- "countries": [
- {
- "displayName": "United Kingdom",
- "countryCode2": "GB"
}
], - "environmentType": "SANDBOX",
- "credentialsType": "OPEN_BANKING_UK_AUTO",
- "media": [
- {
- "type": "icon"
}, - {
- "type": "logo"
}
], - "features": [
- "INITIATE_SINGLE_PAYMENT_SORTCODE",
- "CREATE_DOMESTIC_PERIODIC_PAYMENT",
- "ACCOUNT_REQUEST_DETAILS",
- "ACCOUNT_STATEMENT_FILE",
- "CREATE_SINGLE_PAYMENT_SORTCODE",
- "ACCOUNTS",
- "CREATE_DOMESTIC_SCHEDULED_PAYMENT",
- "ACCOUNT_PERIODIC_PAYMENTS",
- "CREATE_DOMESTIC_SINGLE_PAYMENT",
- "INITIATE_DOMESTIC_PERIODIC_PAYMENT",
- "EXISTING_PAYMENTS_DETAILS",
- "INITIATE_BULK_PAYMENT",
- "EXISTING_PAYMENT_INITIATION_DETAILS",
- "ACCOUNT_DIRECT_DEBITS",
- "ACCOUNT_TRANSACTIONS",
- "INITIATE_DOMESTIC_SINGLE_PAYMENT",
- "PERIODIC_PAYMENT_FREQUENCY_EXTENDED",
- "CREATE_INTERNATIONAL_SINGLE_PAYMENT",
- "ACCOUNT_SCHEDULED_PAYMENTS",
- "ACCOUNT",
- "ACCOUNT_STATEMENTS",
- "ACCOUNT_TRANSACTIONS_WITH_MERCHANT",
- "CREATE_BULK_PAYMENT",
- "ACCOUNT_BALANCES",
- "INITIATE_INTERNATIONAL_SINGLE_PAYMENT",
- "INITIATE_DOMESTIC_SCHEDULED_PAYMENT",
- "ACCOUNT_BENEFICIARIES",
- "IDENTITY",
- "ACCOUNT_STATEMENT",
- "INITIATE_ACCOUNT_REQUEST"
]
}
], - "media": [ ],
- "created": "2020-11-09T10:05:29.897+0000",
- "updated": "2021-04-14T12:51:07.419+0000"
}
The Users endpoints are used to manage each user (otherwise known as the PSU) in Yapily. Each user belongs to an Application and as a consequence, so do each Consent
created for a particular User
.
Get all the users configured in your application
Ok
Error Response
curl -i -X GET \ -u <username>:<password> \ 'https://api.yapily.com/users?filter%5BapplicationUserId%5D=string'
Example Response
[- {
- "uuid": "3b908179-6faa-42e1-8129-8fd0ff1fc68f",
- "applicationUuid": "3020bf54-e254-40ba-ba7b-fc959774486a",
- "applicationUserId": "string",
- "createdAt": "2022-10-17T08:51:02.463Z",
- "institutionConsents": [
- {
- "institutionId": "modelo-sandbox"
}
]
}, - {
- "uuid": "be7dd6fa-1236-41b6-a7a1-5d7863ab9553",
- "applicationUuid": "3020bf54-e254-40ba-ba7b-fc959774486a",
- "referenceId": "hollyhock@9tees.com",
- "createdAt": "2022-10-17T08:51:02.464Z",
- "institutionConsents": [
- {
- "institutionId": "mock-sandbox"
}
]
}, - {
- "uuid": "deb9aac1-b0bc-4f40-9c0b-6a675cf6646f",
- "applicationUuid": "3020bf54-e254-40ba-ba7b-fc959774486a",
- "referenceId": "beatrice@9tees.com",
- "createdAt": "2022-10-17T08:51:02.466Z",
- "institutionConsents": [
- {
- "institutionId": "yapily-mock"
}
]
}
]
Create a new user in your application
Created
Error Response
Create User Example Request
{- "applicationUserId": "string"
}
Example Response
{- "uuid": "1ec8e814-085e-46ad-a303-3fe11808f67e",
- "applicationUuid": "50935110-c7df-4003-a06a-1cc5fd4643c9",
- "applicationUserId": "string",
- "createdAt": "2022-10-17T08:51:02.463Z",
- "institutionConsents": [ ]
}
Delete a user from your application along with any sub-resources (including consent resources on institution APIs if they exist)
Ok
Error Response
curl -i -X DELETE \ -u <username>:<password> \ 'https://api.yapily.com/users/{userUuid}'
Example Response
{- "meta": {
- "tracingId": "e6625041a9fb46e2a450b3f9f1528cb8"
}, - "data": {
- "id": "b8ebe390-f6fb-45b5-bf20-1b4436644390",
- "deleteStatus": "SUCCESS",
- "creationDate": "2021-06-07T16:44:52.221Z",
- "userConsents": [
- {
- "institutionId": "modelo-sandbox"
}
]
}
}
Get a specific user using the user UUID
Ok
Error Response
curl -i -X GET \ -u <username>:<password> \ 'https://api.yapily.com/users/{userUuid}'
Example Response
{- "uuid": "3b908179-6faa-42e1-8129-8fd0ff1fc68f",
- "applicationUuid": "3020bf54-e254-40ba-ba7b-fc959774486a",
- "applicationUserId": "string",
- "createdAt": "2022-10-17T08:51:02.463Z",
- "institutionConsents": [
- {
- "institutionId": "modelo-sandbox"
}
]
}
An Institution
object represents any Account Serving Payment Servicing Provider (ASPSP) that has been integrated and is accessible through the Yapily APIs (ASPSPs are entities that publish Read/Write APIs to permit, with customer consent, payments initiated by third party providers and/or make their customers� financial data available to third party providers via their API endpoints).
Any one of the following would be represented as Institution:
Used to retrieve all features available from Yapily. Each Institution
supports a one, many or all of these features and can be seen in the features field of the Institution
object.
Note: Every Institution
does not necessarily support every feature. To see which features are available for a particular Institution, use either the Get Institutions or Get Institution endpoint and check the features array within the Institution
payload.
Ok
Error Response
curl -i -X GET \ -u <username>:<password> \ https://api.yapily.com/features
Example Response
{- "meta": {
- "tracingId": "b39dc53cf01847098b13f22c559228dd",
- "count": 52
}, - "data": [
- {
- "feature": "ACCOUNT",
}, - {
- "feature": "ACCOUNTS",
}, - {
- "feature": "ACCOUNTS_WITHOUT_BALANCE",
}, - {
- "feature": "ACCOUNT_BALANCES",
}, - {
- "feature": "ACCOUNT_BENEFICIARIES",
}, - {
- "feature": "ACCOUNT_DIRECT_DEBITS",
}, - {
- "feature": "ACCOUNT_PERIODIC_PAYMENTS",
}, - {
- "feature": "ACCOUNT_REQUEST_DETAILS",
}, - {
- "feature": "ACCOUNT_SCHEDULED_PAYMENTS",
}, - {
- "feature": "ACCOUNT_STATEMENT",
}, - {
- "feature": "ACCOUNT_STATEMENTS",
}, - {
- "feature": "ACCOUNT_STATEMENT_FILE",
}, - {
- "feature": "ACCOUNT_TRANSACTIONS",
}, - {
- "feature": "ACCOUNT_TRANSACTIONS_WITH_MERCHANT",
}, - {
- "feature": "ACCOUNT_WITHOUT_BALANCE",
}, - {
- "feature": "CREATE_BULK_PAYMENT",
}, - {
- "feature": "CREATE_DOMESTIC_PERIODIC_PAYMENT",
}, - {
- "feature": "CREATE_DOMESTIC_SCHEDULED_PAYMENT",
}, - {
- "feature": "CREATE_DOMESTIC_SINGLE_INSTANT_PAYMENT",
}, - {
- "feature": "CREATE_DOMESTIC_SINGLE_PAYMENT",
}, - {
- "feature": "CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT",
}, - {
- "feature": "CREATE_INTERNATIONAL_PERIODIC_PAYMENT",
}, - {
- "feature": "CREATE_INTERNATIONAL_SCHEDULED_PAYMENT",
}, - {
- "feature": "CREATE_INTERNATIONAL_SINGLE_PAYMENT",
}, - {
- "feature": "CREATE_SINGLE_PAYMENT_SORTCODE",
}, - {
- "feature": "EXISTING_PAYMENTS_DETAILS",
}, - {
- "feature": "EXISTING_PAYMENT_INITIATION_DETAILS",
}, - {
- "feature": "IDENTITY",
}, - {
- "feature": "INITIATE_ACCOUNT_REQUEST",
}, - {
- "feature": "INITIATE_BULK_PAYMENT",
}, - {
- "feature": "INITIATE_DOMESTIC_PERIODIC_PAYMENT",
}, - {
- "feature": "INITIATE_DOMESTIC_SCHEDULED_PAYMENT",
}, - {
- "feature": "INITIATE_DOMESTIC_SINGLE_INSTANT_PAYMENT",
}, - {
- "feature": "INITIATE_DOMESTIC_SINGLE_PAYMENT",
}, - {
- "feature": "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT",
}, - {
- "feature": "INITIATE_EMBEDDED_ACCOUNT_REQUEST",
}, - {
- "feature": "INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT",
}, - {
- "feature": "INITIATE_EMBEDDED_BULK_PAYMENT",
}, - {
- "feature": "INITIATE_INTERNATIONAL_PERIODIC_PAYMENT",
}, - {
- "feature": "INITIATE_INTERNATIONAL_SCHEDULED_PAYMENT",
}, - {
- "feature": "INITIATE_INTERNATIONAL_SINGLE_PAYMENT",
}, - {
- "feature": "INITIATE_PRE_AUTHORISATION",
}, - {
- "feature": "INITIATE_SINGLE_PAYMENT_SORTCODE",
}, - {
- "feature": "OPEN_DATA_ATMS",
}, - {
- "feature": "OPEN_DATA_PERSONAL_CURRENT_ACCOUNTS",
}, - {
- "feature": "PERIODIC_PAYMENT_FREQUENCY_EXTENDED",
}, - {
- "feature": "READ_DOMESTIC_PERIODIC_PAYMENT_REFUND",
}, - {
- "feature": "READ_DOMESTIC_SCHEDULED_REFUND",
}, - {
- "feature": "READ_DOMESTIC_SINGLE_REFUND",
}, - {
- "feature": "READ_INTERNATIONAL_SCHEDULED_REFUND",
}, - {
- "feature": "READ_INTERNATIONAL_SINGLE_REFUND",
}, - {
- "feature": "TRANSFER",
}
]
}
Used to retrieve all Institutions
within an application
Ok
Error Response
curl -i -X GET \ -u <username>:<password> \ https://api.yapily.com/institutions
Example Response
{- "meta": {
- "tracingId": "1304b771e4e34f67b39977bde6b1a8e2",
- "count": 1
}, - "data": [
- {
- "id": "modelo-sandbox",
- "name": "Modelo Sandbox",
- "fullName": "Modelo Sandbox",
- "countries": [
- {
- "displayName": "United Kingdom",
- "countryCode2": "GB"
}
], - "environmentType": "SANDBOX",
- "credentialsType": "OPEN_BANKING_UK_AUTO",
- "media": [
- {
- "type": "icon"
}, - {
- "type": "logo"
}
], - "features": [
- "ACCOUNT_BALANCES",
- "INITIATE_BULK_PAYMENT",
- "ACCOUNT_BENEFICIARIES",
- "ACCOUNT_SCHEDULED_PAYMENTS",
- "EXISTING_PAYMENTS_DETAILS",
- "ACCOUNT_TRANSACTIONS",
- "ACCOUNT_STATEMENTS",
- "INITIATE_DOMESTIC_PERIODIC_PAYMENT",
- "INITIATE_ACCOUNT_REQUEST",
- "IDENTITY",
- "ACCOUNT_PERIODIC_PAYMENTS",
- "ACCOUNT_REQUEST_DETAILS",
- "ACCOUNT_TRANSACTIONS_WITH_MERCHANT",
- "INITIATE_SINGLE_PAYMENT_SORTCODE",
- "INITIATE_DOMESTIC_SINGLE_PAYMENT",
- "INITIATE_DOMESTIC_SCHEDULED_PAYMENT",
- "ACCOUNT_STATEMENT",
- "CREATE_DOMESTIC_SINGLE_PAYMENT",
- "ACCOUNT_STATEMENT_FILE",
- "CREATE_DOMESTIC_PERIODIC_PAYMENT",
- "CREATE_DOMESTIC_SCHEDULED_PAYMENT",
- "EXISTING_PAYMENT_INITIATION_DETAILS",
- "INITIATE_INTERNATIONAL_SINGLE_PAYMENT",
- "CREATE_SINGLE_PAYMENT_SORTCODE",
- "CREATE_BULK_PAYMENT",
- "CREATE_INTERNATIONAL_SINGLE_PAYMENT",
- "ACCOUNT",
- "PERIODIC_PAYMENT_FREQUENCY_EXTENDED",
- "ACCOUNT_DIRECT_DEBITS",
- "ACCOUNTS"
]
}
]
}
Used to retrieves details of a specific Institution
within an application
Ok
Error Response
curl -i -X GET \ -u <username>:<password> \ 'https://api.yapily.com/institutions/{institutionId}'
Example Response
{- "id": "modelo-sandbox",
- "name": "Modelo Sandbox",
- "fullName": "Modelo Sandbox",
- "countries": [
- {
- "displayName": "United Kingdom",
- "countryCode2": "GB"
}
], - "environmentType": "SANDBOX",
- "credentialsType": "OPEN_BANKING_UK_AUTO",
- "media": [
- {
- "type": "icon"
}, - {
- "type": "logo"
}
], - "features": [
- "ACCOUNT_BALANCES",
- "INITIATE_BULK_PAYMENT",
- "ACCOUNT_BENEFICIARIES",
- "ACCOUNT_SCHEDULED_PAYMENTS",
- "EXISTING_PAYMENTS_DETAILS",
- "ACCOUNT_TRANSACTIONS",
- "ACCOUNT_STATEMENTS",
- "INITIATE_DOMESTIC_PERIODIC_PAYMENT",
- "INITIATE_ACCOUNT_REQUEST",
- "IDENTITY",
- "ACCOUNT_PERIODIC_PAYMENTS",
- "ACCOUNT_REQUEST_DETAILS",
- "ACCOUNT_TRANSACTIONS_WITH_MERCHANT",
- "INITIATE_SINGLE_PAYMENT_SORTCODE",
- "INITIATE_DOMESTIC_SINGLE_PAYMENT",
- "INITIATE_DOMESTIC_SCHEDULED_PAYMENT",
- "ACCOUNT_STATEMENT",
- "CREATE_DOMESTIC_SINGLE_PAYMENT",
- "ACCOUNT_STATEMENT_FILE",
- "CREATE_DOMESTIC_PERIODIC_PAYMENT",
- "CREATE_DOMESTIC_SCHEDULED_PAYMENT",
- "EXISTING_PAYMENT_INITIATION_DETAILS",
- "INITIATE_INTERNATIONAL_SINGLE_PAYMENT",
- "CREATE_SINGLE_PAYMENT_SORTCODE",
- "CREATE_BULK_PAYMENT",
- "CREATE_INTERNATIONAL_SINGLE_PAYMENT",
- "ACCOUNT",
- "PERIODIC_PAYMENT_FREQUENCY_EXTENDED",
- "ACCOUNT_DIRECT_DEBITS",
- "ACCOUNTS"
]
}
The Consents endpoints are used to manage each Consent
created by Yapily in response to an authorisation created for a user.
The Consent
object contains data that identifies a user's consent for a specific Institution
within a Yapily application. Other than the id of the consent, the institution-id
for the corresponding Institution
and the user identifiers (user-uuid
and application-user-id
), it contains various details that indicates how the Consent
can be used.
Used to obtain a Yapily Consent object containing the consentToken
once the user has authenticated and you have an OAuth2 authorisation code auth-code
and state auth-state
.
Ok
Error Response
{- "authCode": "6b965fbb-ff09-4afa-b897-90c34797cb8f",
- "authState": "1270cb2ffc4842b78953afa2228e0a87"
}
Example Response
{- "id": "56a42244-414a-4b52-8c4f-4ad2a50e82fe",
- "userUuid": "ca412fdf-5a30-43a2-88b7-5964a24a8e55",
- "applicationUserId": "string",
- "institutionId": "modelo-sandbox",
- "status": "AUTHORIZED",
- "createdAt": "2021-06-08T10:59:35.138Z",
- "featureScope": [
- "ACCOUNT_BENEFICIARIES",
- "ACCOUNT_STATEMENT_FILE",
- "ACCOUNTS",
- "ACCOUNT_PERIODIC_PAYMENTS",
- "ACCOUNT_TRANSACTIONS",
- "ACCOUNT",
- "ACCOUNT_STATEMENTS",
- "ACCOUNT_SCHEDULED_PAYMENTS",
- "IDENTITY",
- "ACCOUNT_DIRECT_DEBITS",
- "ACCOUNT_STATEMENT",
- "ACCOUNT_BALANCES",
- "ACCOUNT_TRANSACTIONS_WITH_MERCHANT"
], - "consentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg",
- "state": "a09f8ff9c1284444aa635267e05f76e1",
- "authorizedAt": "2021-06-08T10:59:53.288Z",
- "institutionConsentId": "aac-605d48f2-2a0e-4594-81a9-996524fa3b2a"
}
Exchange a One-time-token for the consent token
Created
Error Response
{- "oneTimeToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6ImJidmEtc2FuZGJveCIsIlVVSUQiOiJmMzNmNGU4ZC1jMDQ0LTQ2YTktOTlkMC0wYmRlMzIyYTJjOTIifQ.4Qv3NJI6av2nKi1U3aNmm71cIwJ3TvRsIlYDafQUVv_Khy_e-8oEpV_BoP4V1CII12oT-Yq4cPveHILz8BOwjg"
}
Example Response
{- "id": "56a42244-414a-4b52-8c4f-4ad2a50e82fe",
- "userUuid": "ca412fdf-5a30-43a2-88b7-5964a24a8e55",
- "applicationUserId": "string",
- "institutionId": "modelo-sandbox",
- "status": "AUTHORIZED",
- "createdAt": "2021-06-08T10:59:35.138Z",
- "featureScope": [
- "ACCOUNT_BENEFICIARIES",
- "ACCOUNT_STATEMENT_FILE",
- "ACCOUNTS",
- "ACCOUNT_PERIODIC_PAYMENTS",
- "ACCOUNT_TRANSACTIONS",
- "ACCOUNT",
- "ACCOUNT_STATEMENTS",
- "ACCOUNT_SCHEDULED_PAYMENTS",
- "IDENTITY",
- "ACCOUNT_DIRECT_DEBITS",
- "ACCOUNT_STATEMENT",
- "ACCOUNT_BALANCES",
- "ACCOUNT_TRANSACTIONS_WITH_MERCHANT"
], - "consentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg",
- "state": "a09f8ff9c1284444aa635267e05f76e1",
- "authorizedAt": "2021-06-08T10:59:53.288Z",
- "institutionConsentId": "aac-605d48f2-2a0e-4594-81a9-996524fa3b2a"
}
Used to retrieve all the consents created for each user within an application
filter[applicationUserId] | Array of strings unique Optional. Filter records based on the list of |
filter[userUuid] | Array of strings <uuid> unique Optional. Filter records based on the list of |
filter[institution] | Array of strings unique Optional. Filter records based on the list of |
filter[status] | Array of strings unique Optional. Filter records based on the list of |
from | string Optional. Returned transactions will be on or after this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ). |
before | string Optional. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ). |
limit | integer <int32> Optional. The maximum number of transaction records to be returned. Must be between 1 and 1000. |
offset | integer <int32> Default: 0 Optional. The number of transaction records to be skipped. Used primarily with paginated results. |
Ok
Error Response
curl -i -X GET \ -u <username>:<password> \ 'https://api.yapily.com/consents?filter%5BapplicationUserId%5D=string&filter%5BuserUuid%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&filter%5Binstitution%5D=string&filter%5Bstatus%5D=string&from=string&before=string&limit=0&offset=0'
Example Response
{- "meta": {
- "tracingId": "d7b537b108934105a522dc7b4522380b",
- "count": 1,
- "pagination": {
- "totalCount": 1,
- "self": {
- "sort": "-date",
- "offset": 0
}
}
}, - "data": [
- {
- "id": "56a42244-414a-4b52-8c4f-4ad2a50e82fe",
- "userUuid": "ca412fdf-5a30-43a2-88b7-5964a24a8e55",
- "applicationUserId": "string",
- "institutionId": "modelo-sandbox",
- "status": "AUTHORIZED",
- "createdAt": "2021-06-08T10:59:35.138Z",
- "featureScope": [
- "ACCOUNT_BENEFICIARIES",
- "ACCOUNT_STATEMENT_FILE",
- "ACCOUNTS",
- "ACCOUNT_PERIODIC_PAYMENTS",
- "ACCOUNT_TRANSACTIONS",
- "ACCOUNT",
- "ACCOUNT_STATEMENTS",
- "ACCOUNT_SCHEDULED_PAYMENTS",
- "IDENTITY",
- "ACCOUNT_DIRECT_DEBITS",
- "ACCOUNT_STATEMENT",
- "ACCOUNT_BALANCES",
- "ACCOUNT_TRANSACTIONS_WITH_MERCHANT"
], - "consentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg",
- "state": "a09f8ff9c1284444aa635267e05f76e1",
- "authorizedAt": "2021-06-08T10:59:53.288Z",
- "institutionConsentId": "aac-605d48f2-2a0e-4594-81a9-996524fa3b2a"
}
]
}
Delete a consent using the consent Id
Ok
Error Response
curl -i -X DELETE \ -u <username>:<password> \ 'https://api.yapily.com/consents/{consentId}?forceDelete=true'
Example Response
{- "meta": {
- "tracingId": "9aacaccc6dbf4a86960c9541969087a0"
}, - "data": {
- "id": "56a42244-414a-4b52-8c4f-4ad2a50e82fe",
- "deleteStatus": "SUCCESS",
- "institutionId": "modelo-sandbox",
- "institutionConsentId": "aac-605d48f2-2a0e-4594-81a9-996524fa3b2a",
- "creationDate": "2021-06-08T10:59:35.138Z"
}
}
curl -i -X GET \ -u <username>:<password> \ 'https://api.yapily.com/consents/{consentId}'
Example Response
{- "meta": {
- "tracingId": "679e7bb6cd45416a9a9a8d004c5315da"
}, - "data": {
- "id": "56a42244-414a-4b52-8c4f-4ad2a50e82fe",
- "userUuid": "ca412fdf-5a30-43a2-88b7-5964a24a8e55",
- "applicationUserId": "string",
- "institutionId": "modelo-sandbox",
- "status": "AUTHORIZED",
- "createdAt": "2021-06-08T10:59:35.138Z",
- "featureScope": [
- "ACCOUNT_BENEFICIARIES",
- "ACCOUNT_STATEMENT_FILE",
- "ACCOUNTS",
- "ACCOUNT_PERIODIC_PAYMENTS",
- "ACCOUNT_TRANSACTIONS",
- "ACCOUNT",
- "ACCOUNT_STATEMENTS",
- "ACCOUNT_SCHEDULED_PAYMENTS",
- "IDENTITY",
- "ACCOUNT_DIRECT_DEBITS",
- "ACCOUNT_STATEMENT",
- "ACCOUNT_BALANCES",
- "ACCOUNT_TRANSACTIONS_WITH_MERCHANT"
], - "consentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg",
- "state": "a09f8ff9c1284444aa635267e05f76e1",
- "authorizedAt": "2021-06-08T10:59:53.288Z",
- "lastConfirmedAt": "2021-07-08T10:59:53.288Z",
- "reconfirmBy": "2021-10-06T10:59:53.288Z",
- "institutionConsentId": "aac-605d48f2-2a0e-4594-81a9-996524fa3b2a"
}
}
Used to indicate to Yapily that reconfirmation has occurred for a given Consent, and to update lastUpdatedAt and reconfirmBy for that Consent. Returns the Consent.
Created
Error Response. The supplied lastConfirmedAt date, Consent type, or Consent status is invalid.
Error Response
Extend Consent Example Request
{- "lastConfirmedAt": "2021-07-08T10:59:53.288Z"
}
Example Response
{- "meta": {
- "tracingId": "679e7bb6cd45416a9a9a8d004c5315da"
}, - "data": {
- "id": "56a42244-414a-4b52-8c4f-4ad2a50e82fe",
- "userUuid": "ca412fdf-5a30-43a2-88b7-5964a24a8e55",
- "applicationUserId": "string",
- "institutionId": "modelo-sandbox",
- "status": "AUTHORIZED",
- "createdAt": "2021-06-08T10:59:35.138Z",
- "featureScope": [
- "ACCOUNT_BENEFICIARIES",
- "ACCOUNT_STATEMENT_FILE",
- "ACCOUNTS",
- "ACCOUNT_PERIODIC_PAYMENTS",
- "ACCOUNT_TRANSACTIONS",
- "ACCOUNT",
- "ACCOUNT_STATEMENTS",
- "ACCOUNT_SCHEDULED_PAYMENTS",
- "IDENTITY",
- "ACCOUNT_DIRECT_DEBITS",
- "ACCOUNT_STATEMENT",
- "ACCOUNT_BALANCES",
- "ACCOUNT_TRANSACTIONS_WITH_MERCHANT"
], - "consentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg",
- "state": "a09f8ff9c1284444aa635267e05f76e1",
- "authorizedAt": "2021-06-08T10:59:53.288Z",
- "lastConfirmedAt": "2021-07-08T10:59:53.288Z",
- "reconfirmBy": "2021-10-06T10:59:53.288Z",
- "institutionConsentId": "aac-605d48f2-2a0e-4594-81a9-996524fa3b2a"
}
}
Before calling Financial Data or Payments endpoints, a consent from an end-user must be obtained.
Consents are valid for up to 90 days for Financial Data endpoints and have a single-use for Payment endpoints i.e. a new consent must be obtained for each payment.
Used to prompt the account holder for continued access to their financial data. This endpoint should be used when a Consent
that was previously AUTHORIZED
can no longer be used to retrieve data.
See Re-Authorisation for more information.
consent required | string Mandatory. The Example: {consentToken} |
psu-id | string Conditional. Represents the user's login ID for the |
psu-corporate-id | string Conditional. Represents the user's login ID for the |
psu-ip-address | string Conditional. The IP address of the PSU. |
sub-application | string <uuid> The sub-application ID to which event type is being subscribed to |
Created
Error Response
curl -i -X PATCH \ -u <username>:<password> \ 'https://api.yapily.com/account-auth-requests?raw=true' \ -H 'consent: string' \ -H 'psu-corporate-id: string' \ -H 'psu-id: string' \ -H 'psu-ip-address: string' \ -H 'sub-application: 497f6eca-6276-4993-bfeb-53cbbbba6f08'
OBIE Example Response
{- "meta": {
- "tracingId": "8719f9c97272463d9c2d1ee6108c8e24"
}, - "data": {
- "id": "2812b61c-9d0b-4730-8c94-22c18918e66a",
- "userUuid": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d",
- "applicationUserId": "string",
- "institutionId": "modelo-sandbox",
- "status": "AWAITING_RE_AUTHORIZATION",
- "createdAt": "2021-06-09T08:22:50.135Z",
- "featureScope": [
- "ACCOUNT_STATEMENT_FILE",
- "ACCOUNT_TRANSACTIONS",
- "ACCOUNT_STATEMENTS",
- "ACCOUNTS",
- "ACCOUNT"
], - "state": "0623e536c5044b4aa3f6c66e7537bee0",
- "authorizedAt": "2021-06-09T08:23:03.944Z",
- "institutionConsentId": "aac-f7847e99-7c66-4bb8-8641-61a24057f2e8",
}
}
Used to initiate the authorisation process and direct users to the login screen of their financial institution in order to give consent to access account data.
See Redirect Account Flows for more information about this flow.
Feature: INITIATE_ACCOUNT_REQUEST
psu-id | string Conditional. Represents the user's login ID for the |
psu-corporate-id | string Conditional. Represents the user's login ID for the |
psu-ip-address | string Conditional. The IP address of the PSU. |
sub-application | string <uuid> The sub-application ID to which event type is being subscribed to |
userUuid | string <uuid>
|
applicationUserId | string Conditional. User-friendly identifier of the |
forwardParameters | Array of strings Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect. |
institutionId required | string Mandatory. The reference to the |
callback | string Optional. The server to redirect the user to after the user completes the authorisation at the |
object (RedirectRequest) Optional. The server to redirect the user to after the user complete the authorisation at the | |
oneTimeToken | boolean Conditional. Used to receive a |
object (AccountRequest) Conditional. Used to further specify details of the
|
Created
Error Response
OBIE Example Request
{- "applicationUserId": "string",
- "institutionId": "modelo-sandbox",
}
OBIE Example Response
{- "meta": {
- "tracingId": "3b262569303f47f188d16b43acd552c0"
}, - "data": {
- "id": "2d5c3632-1729-4a5e-bc69-c7fa1cbba815",
- "userUuid": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d",
- "applicationUserId": "string",
- "institutionId": "modelo-sandbox",
- "status": "AWAITING_AUTHORIZATION",
- "createdAt": "2021-06-09T08:03:20.510Z",
- "featureScope": [
- "ACCOUNT_STATEMENT_FILE",
- "ACCOUNTS",
- "ACCOUNT_STATEMENTS",
- "ACCOUNT_TRANSACTIONS",
- "ACCOUNT",
- "ACCOUNT_BALANCES",
- "ACCOUNT_STATEMENT",
- "ACCOUNT_SCHEDULED_PAYMENTS",
- "ACCOUNT_TRANSACTIONS_WITH_MERCHANT",
- "ACCOUNT_PERIODIC_PAYMENTS",
- "ACCOUNT_BENEFICIARIES",
- "IDENTITY",
- "ACCOUNT_DIRECT_DEBITS"
], - "state": "7948ba4d6a064001b06ef28f8c06ca4a",
- "institutionConsentId": "aac-0a743a0f-0b7d-4e7b-87eb-0bc65e1d2f97",
}
}
Used to continue the authorisation process and for any Institution
that contains the INITIATE_PRE_AUTHORISATION
feature and direct user to the login screen of their financial institution in order to give consent to access account data.
See Redirect Account Flows for more information about this flow.
Features:
INITIATE_ACCOUNT_REQUEST
INITIATE_PRE_AUTHORISATION
consent required | string Mandatory. The Example: {consentToken} |
psu-id | string Conditional. Represents the user's login ID for the |
psu-corporate-id | string Conditional. Represents the user's login ID for the |
psu-ip-address | string Conditional. The IP address of the PSU. |
sub-application | string <uuid> The sub-application ID to which event type is being subscribed to |
userUuid | string <uuid>
|
applicationUserId | string Conditional. User-friendly identifier of the |
forwardParameters | Array of strings Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect. |
institutionId required | string Mandatory. The reference to the |
callback | string Optional. The server to redirect the user to after the user completes the authorisation at the |
object (RedirectRequest) Optional. The server to redirect the user to after the user complete the authorisation at the | |
oneTimeToken | boolean Conditional. Used to receive a |
object (AccountRequest) Conditional. Used to further specify details of the
|
Ok
Error Response
Berlin Group Example Request
{- "applicationUserId": "string",
- "institutionId": "n26"
}
OBIE Example Response
{- "meta": {
- "tracingId": "ee8e5bcfedf348b18ae45a34135790cc"
}, - "data": {
- "id": "68e14e00-38b0-467d-a999-f70340e467b3",
- "userUuid": "e2578545-27a4-4edf-983f-5d33c2d7b559",
- "applicationUserId": "string",
- "institutionId": "n26",
- "institutionConsentId": "87ec9ded-d5ea-4fb6-80c5-ad4c88246c9f",
- "state": "4f4f9766f7264afc96a5269d6e65e066",
- "status": "AWAITING_DECOUPLED_AUTHORIZATION",
- "authorizedAt": "2021-05-13T09:00:06.867Z",
- "createdAt": "2021-05-13T08:59:23.864Z",
- "featureScope": [
- "ACCOUNT_TRANSACTIONS",
- "INITIATE_PRE_AUTHORISATION",
- "ACCOUNTS",
- "ACCOUNT_TRANSACTIONS_WITH_MERCHANT"
]
}
}
Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for a bulk payment. See Bulk Payments for more information.
See Redirect Payment Flows for more information about this flow.
Feature: INITIATE_BULK_PAYMENT
psu-id | string Conditional. Represents the user's login ID for the |
psu-corporate-id | string Conditional. Represents the user's login ID for the |
psu-ip-address | string Conditional. The IP address of the PSU. |
userUuid | string <uuid> Conditional. The reference to the |
applicationUserId | string Conditional. The user-friendly reference to the |
forwardParameters | Array of strings Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect. |
institutionId required | string Mandatory. The reference to the |
callback | string Optional. The server to redirect the user to after the user complete the authorisation at the |
object (RedirectRequest) Optional. The server to redirect the user to after the user complete the authorisation at the | |
oneTimeToken | boolean Conditional. Used to receive a |
object (BulkPaymentRequest) The payment request object defining the details of the bulk payment |
Created
Error Response
UK Bulk Payment Example Request
{- "applicationUserId": "string",
- "institutionId": "modelo-sandbox",
- "paymentRequest": {
- "payments": [
- {
- "type": "DOMESTIC_PAYMENT",
- "paymentIdempotencyId": "d78fy48uh8f9odhde68dfi38di9",
- "reference": "payment1",
- "contextType": "BILL_IN_ARREARS",
- "purposeCode": "COMT",
- "amount": {
- "amount": 2,
- "currency": "GBP"
}, - "payee": {
- "name": "Jane Doe",
- "accountIdentifications": [
- {
- "type": "ACCOUNT_NUMBER",
- "identification": "12345678"
}, - {
- "type": "SORT_CODE",
- "identification": "123456"
}
], - "accountType": "BUSINESS_SAVING"
}
}, - {
- "type": "DOMESTIC_PAYMENT",
- "paymentIdempotencyId": "4279gdy8t63dg73gd8gx87738dg",
- "reference": "payment2",
- "contextType": "BILL_IN_ARREARS",
- "purposeCode": "COMT",
- "amount": {
- "amount": 5,
- "currency": "GBP"
}, - "payee": {
- "name": "John Doe",
- "accountIdentifications": [
- {
- "type": "ACCOUNT_NUMBER",
- "identification": "87654321"
}, - {
- "type": "SORT_CODE",
- "identification": "654321"
}
], - "accountType": "BUSINESS_SAVING"
}
}
]
}
}
UK Bulk Payment Example Response
{- "meta": {
- "tracingId": "96169af01d394ad39658f17d53b49a5d"
}, - "data": {
- "id": "a2a9ec77-a479-4996-9896-4568e1968e7a",
- "userUuid": "5350782b-60f3-489e-aae5-a24d8d679a07",
- "applicationUserId": "string",
- "institutionId": "modelo-sandbox",
- "status": "AWAITING_AUTHORIZATION",
- "createdAt": "2021-06-09T13:48:25.138Z",
- "featureScope": [
- "EXISTING_PAYMENTS_DETAILS",
- "EXISTING_PAYMENT_INITIATION_DETAILS",
- "CREATE_BULK_PAYMENT"
], - "state": "80052c03007f41d589f64377eef4d620",
- "institutionConsentId": "sdp-6-25ff5bd8-d01c-422d-aa9e-8e68808bc899",
}
}
Used to initiate the embedded authorisation process for an Institution
that contains the INITIATE_EMBEDDED_ACCOUNT_REQUEST
feature in order to obtain the the user's authorisation to access their account information.
See Embedded Account Flows for more information about this flow.
Feature: INITIATE_EMBEDDED_ACCOUNT_REQUEST
psu-id | string Conditional. Represents the user's login ID for the |
psu-corporate-id | string Conditional. Represents the user's login ID for the |
psu-ip-address | string Conditional. The IP address of the PSU. |
sub-application | string <uuid> The sub-application ID to which event type is being subscribed to |
userUuid | string <uuid>
|
applicationUserId | string Conditional. The user-friendly reference to the |
forwardParameters | Array of strings Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect. |
institutionId required | string Mandatory. The reference to the |
callback | string Optional. The server to redirect the user to after the user complete the authorisation at the |
object (RedirectRequest) Optional. The server to redirect the user to after the user complete the authorisation at the | |
oneTimeToken | boolean Conditional. Used to receive a |
object (UserCredentials) Conditional. Used to capture the user's credentials to allow them to login to an | |
object (ScaMethod) Conditional. Used to update the authorisation with the sca method of the user's choice for the | |
scaCode | string Conditional. Used to update the authorisation with the sca code received by the user from the |
object (AccountRequest) Conditional. Used to further specify details of the
|
Created
Error Response
Berlin Group Example Request
{- "applicationUserId": "string",
- "institutionId": "fiducia-sandbox",
- "userCredentials": {
- "id": "6154057725",
- "password": "PISPWD12"
}
}
Berlin Group (Multiple SCA Methods) Example Response
{- "meta": {
- "tracingId": "a9d8d8c5e6a84b00b8510d90c28cbbc6"
}, - "data": {
- "id": "149da283-2958-4128-9d72-e3a02e8bb83d",
- "userUuid": "6b082877-b137-4743-bba3-07b6a8148b42",
- "applicationUserId": "string",
- "institutionId": "fiducia-sandbox",
- "status": "AWAITING_SCA_METHOD",
- "createdAt": "2021-06-09T11:47:24.513Z",
- "expiresAt": "2021-09-07T00:00:00Z",
- "timeToExpire": "P89DT12H12M35.472S",
- "featureScope": [
- "ACCOUNT_TRANSACTIONS",
- "ACCOUNTS",
- "ACCOUNT",
- "ACCOUNT_BALANCES"
], - "state": "c99f35c118194737b83487a0e6a48ed9",
- "institutionConsentId": "4514274319060120226PSDLT-BL-LB002045CO9545RW",
- "scaMethods": [
- {
- "id": "962",
- "type": "CHIP_OTP",
- "description": "SmartTAN plus HHD 1.4"
}, - {
- "id": "952",
- "type": "CHIP_OTP",
- "description": "SmartTAN optic"
}, - {
- "id": "972",
- "type": "CHIP_OTP",
- "description": "SmartTAN optic/USB HHD 1.4"
}, - {
- "id": "982",
- "type": "PHOTO_OTP",
- "description": "Smart-TAN photo"
}, - {
- "id": "932",
- "type": "CHIP_OTP",
- "description": "SmartTAN plus"
}, - {
- "id": "944",
- "type": "PUSH_OTP",
- "description": "SecureSIGN"
}, - {
- "id": "942",
- "type": "SMS_OTP",
- "description": "mobile TAN"
}
]
}
}
Used to pass the SCA Code received from the Institution
(and the SCA method selected by the user where multiple SCA methods are supported by the Institution
) in order to complete the embedded authorisation to access the user's financial data.
See Embedded Account Flows for more information about this flow.
Feature: INITIATE_EMBEDDED_ACCOUNT_REQUEST
psu-id | string Conditional. Represents the user's login ID for the |
psu-corporate-id | string Conditional. Represents the user's login ID for the |
psu-ip-address | string Conditional. The IP address of the PSU. |
sub-application | string <uuid> The sub-application ID to which event type is being subscribed to |
userUuid | string <uuid>
|
applicationUserId | string Conditional. The user-friendly reference to the |
forwardParameters | Array of strings Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect. |
institutionId required | string Mandatory. The reference to the |
callback | string Optional. The server to redirect the user to after the user complete the authorisation at the |
object (RedirectRequest) Optional. The server to redirect the user to after the user complete the authorisation at the | |
oneTimeToken | boolean Conditional. Used to receive a |
object (UserCredentials) Conditional. Used to capture the user's credentials to allow them to login to an | |
object (ScaMethod) Conditional. Used to update the authorisation with the sca method of the user's choice for the | |
scaCode | string Conditional. Used to update the authorisation with the sca code received by the user from the |
object (AccountRequest) Conditional. Used to further specify details of the
|
Created
Error Response
Berlin Group (SCA Code) Example Request
{- "applicationUserId": "string",
- "institutionId": "fiducia-sandbox",
- "scaCode": "6154057725"
}
Berlin Group (SCA Code) Example Response
{- "meta": {
- "tracingId": "0ad7c46c4e4445bab3a0d4ccae25556b"
}, - "data": {
- "id": "66c8c0f2-1678-4404-a68f-2236a1afcdad",
- "userUuid": "6b082877-b137-4743-bba3-07b6a8148b42",
- "applicationUserId": "string",
- "institutionId": "fiducia-sandbox",
- "status": "AUTHORIZED",
- "createdAt": "2021-06-09T11:49:18.815Z",
- "featureScope": [
- "ACCOUNT_TRANSACTIONS",
- "ACCOUNTS",
- "ACCOUNT",
- "ACCOUNT_BALANCES"
], - "state": "3fb4024282d0432cb710094c4c723ae5",
- "authorizedAt": "2021-06-09T11:51:14.140Z",
- "institutionConsentId": "1448194319060120228PSDLT-BL-LB002045CO9545RW"
}
}
Used to initiate the embedded authorisation process for an Institution
that contains the INITIATE_EMBEDDED_BULK_PAYMENT
feature in order to obtain the the user's authorisation for a bulk payment. See Bulk Payments for more information.
See Embedded Payment Flows for more information about this flow.
Feature: INITIATE_EMBEDDED_BULK_PAYMENT
psu-id | string Conditional. Represents the user's login ID for the |
psu-corporate-id | string Conditional. Represents the user's login ID for the |
psu-ip-address | string Conditional. The IP address of the PSU. |
userUuid | string <uuid> Conditional. The reference to the |
applicationUserId | string Conditional. The user-friendly reference to the |
institutionId required | string Mandatory. The reference to the |
callback | string Optional. The server to redirect the user to after the user complete the authorisation at the |
object (RedirectRequest) Optional. The server to redirect the user to after the user complete the authorisation at the | |
oneTimeToken | boolean Conditional. Used to receive a |
object (BulkPaymentRequest) The payment request object defining the details of the bulk payment | |
object (UserCredentials) Conditional. Used to capture the user's credentials to allow them to login to an | |
object (ScaMethod) Conditional. Used to update the authorisation with the sca method of the user's choice for the | |
scaCode | string Conditional. Used to update the authorisation with the sca code received by the user from the |
Created
Error Response
Berlin Group EUR Embedded Bulk Payment Example Request
{- "applicationUserId": "string",
- "institutionId": "fiducia-sandbox",
- "userCredentials": {
- "id": "VRK1234567890PLUS",
- "password": "password"
}, - "paymentRequest": {
- "executionDateTime": "2021-10-29T00:00:00Z",
- "payments": [
- {
- "type": "DOMESTIC_PAYMENT",
- "paymentIdempotencyId": "e4f913909a3d11eabb370242ac130002",
- "reference": "REFERENCE",
- "amount": {
- "amount": 1,
- "currency": "EUR"
}, - "payer": {
- "name": "John Doe",
- "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE39499999600000005111"
}
]
}, - "payee": {
- "name": "Jane Doe",
- "address": {
- "country": "DE"
}, - "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE12345678901234567890"
}
]
}
}, - {
- "type": "DOMESTIC_PAYMENT",
- "paymentIdempotencyId": "e4f913909a3d11eabb370242ac130002",
- "reference": "REFERENCE",
- "amount": {
- "amount": 1,
- "currency": "EUR"
}, - "payer": {
- "name": "Jane Doe",
- "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE39499999600000005111"
}
]
}, - "payee": {
- "name": "John Doe",
- "address": {
- "country": "DE"
}, - "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE12345678900000000000"
}
]
}
}
]
}
}
Berlin Group EUR Embedded Bulk Payment Example Response
{- "meta": {
- "tracingId": "4ab90c8cc13a4b74ba855a48100d6084"
}, - "data": {
- "id": "6117b6dd-5a43-4f26-8e36-b91b9bf3c434",
- "userUuid": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d",
- "applicationUserId": "string",
- "institutionId": "fiducia-sandbox",
- "status": "AWAITING_SCA_CODE",
- "createdAt": "2021-08-02T14:58:45.446Z",
- "featureScope": [
- "EXISTING_PAYMENT_INITIATION_DETAILS",
- "CREATE_BULK_PAYMENT",
- "EXISTING_PAYMENTS_DETAILS"
], - "state": "85853421299c44e0829debefffd8622e",
- "institutionConsentId": "0515485612080120206PSDLT-BL-LB002045PA9545RW",
- "scaMethods": [
- {
- "id": "932",
- "type": "CHIP_OTP",
- "description": "SmartTAN plus"
}
], - "selectedScaMethod": {
- "id": "932",
- "type": "CHIP_OTP",
- "description": "SmartTAN plus"
}
}
}
Used to pass the SCA Code received from the Institution
(and the SCA method selected by the user where multiple SCA methods are supported by the Institution
) in order to complete the embedded authorisation to initiate a bulk payment. See Bulk Payments for more information.
See Embedded Payment Flows for more information about this flow.
Feature: INITIATE_EMBEDDED_BULK_PAYMENT
psu-id | string Conditional. Represents the user's login ID for the |
psu-corporate-id | string Conditional. Represents the user's login ID for the |
psu-ip-address | string Conditional. The IP address of the PSU. |
userUuid | string <uuid> Conditional. The reference to the |
applicationUserId | string Conditional. The user-friendly reference to the |
institutionId required | string Mandatory. The reference to the |
callback | string Optional. The server to redirect the user to after the user complete the authorisation at the |
object (RedirectRequest) Optional. The server to redirect the user to after the user complete the authorisation at the | |
oneTimeToken | boolean Conditional. Used to receive a |
object (BulkPaymentRequest) The payment request object defining the details of the bulk payment | |
object (UserCredentials) Conditional. Used to capture the user's credentials to allow them to login to an | |
object (ScaMethod) Conditional. Used to update the authorisation with the sca method of the user's choice for the | |
scaCode | string Conditional. Used to update the authorisation with the sca code received by the user from the |
Ok
Error Response
Berlin Group EUR Embedded Bulk Payment (SCA Code) Example Request
{- "applicationUserId": "string",
- "institutionId": "fiducia-sandbox",
- "scaCode": "123456",
- "paymentRequest": {
- "executionDateTime": "2021-10-29T00:00:00Z",
- "payments": [
- {
- "type": "DOMESTIC_PAYMENT",
- "paymentIdempotencyId": "e4f913909a3d11eabb370242ac130002",
- "reference": "REFERENCE",
- "amount": {
- "amount": 1,
- "currency": "EUR"
}, - "payer": {
- "name": "John Doe",
- "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE39499999600000005111"
}
]
}, - "payee": {
- "name": "Jane Doe",
- "address": {
- "country": "DE"
}, - "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE12345678901234567890"
}
]
}
}, - {
- "type": "DOMESTIC_PAYMENT",
- "paymentIdempotencyId": "e4f913909a3d11eabb370242ac130002",
- "reference": "REFERENCE",
- "amount": {
- "amount": 1,
- "currency": "EUR"
}, - "payer": {
- "name": "Jane Doe",
- "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE39499999600000005111"
}
]
}, - "payee": {
- "name": "John Doe",
- "address": {
- "country": "DE"
}, - "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE12345678900000000000"
}
]
}
}
]
}
}
Berlin Group EUR Embedded Bulk Payment (SCA Code) Example Response
{- "meta": {
- "tracingId": "cfa351c5de6f4398bb9deea04041acc5"
}, - "data": {
- "id": "6117b6dd-5a43-4f26-8e36-b91b9bf3c434",
- "userUuid": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d",
- "applicationUserId": "string",
- "institutionId": "fiducia-sandbox",
- "status": "AUTHORIZED",
- "createdAt": "2021-08-02T14:58:45.446Z",
- "featureScope": [
- "EXISTING_PAYMENT_INITIATION_DETAILS",
- "CREATE_BULK_PAYMENT",
- "EXISTING_PAYMENTS_DETAILS"
], - "state": "85853421299c44e0829debefffd8622e",
- "authorizedAt": "2021-08-02T14:59:29.174Z",
- "institutionConsentId": "0515485612080120206PSDLT-BL-LB002045PA9545RW"
}
}
Used to initiate the embedded authorisation process for an Institution
that contains the INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT
feature in order to obtain the the user's authorisation for a payment.
See Embedded Payment Flows for more information about this flow.
Feature: INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT
psu-id | string Conditional. Represents the user's login ID for the |
psu-corporate-id | string Conditional. Represents the user's login ID for the |
psu-ip-address | string Conditional. The IP address of the PSU. |
sub-application | string <uuid> The sub-application ID to which event type is being subscribed to |
userUuid | string <uuid> |
applicationUserId | string Conditional. The user-friendly reference to the |
institutionId required | string Mandatory. The reference to the |
callback | string Optional. The server to redirect the user to after the user complete the authorisation at the |
object (RedirectRequest) Optional. The server to redirect the user to after the user complete the authorisation at the | |
oneTimeToken | boolean Conditional. Used to receive a |
required | object (PaymentRequest) Mandatory. The payment request object defining the details of the payment. |
object (UserCredentials) Conditional. Used to capture the user's credentials to allow them to login to an | |
object (ScaMethod) Conditional. Used to update the authorisation with the sca method of the user's choice for the | |
scaCode | string Conditional. Used to update the authorisation with the sca code received by the user from the |
Created
Error Response
Berlin Group EUR Single Domestic Payment Example Request
{- "applicationUserId": "string",
- "institutionId": "postbank-sandbox",
- "userCredentials": {
- "id": "6154057725",
- "password": "PISPWD12"
}, - "paymentRequest": {
- "type": "DOMESTIC_PAYMENT",
- "paymentIdempotencyId": "e4f913909a3d11eabb370242ac130002",
- "reference": "REFERENCE",
- "amount": {
- "amount": 1,
- "currency": "EUR"
}, - "payer": {
- "name": "John Doe",
- "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE12345678901234567890"
}
]
}, - "payee": {
- "name": "Jane Doe",
- "address": {
- "country": "DE"
}, - "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE09876543210987654321"
}
]
}
}
}
Berlin Group EUR Single Domestic Payment Example Response
{- "meta": {
- "tracingId": "bcebc29b55434cc8b2aae80cb782edff"
}, - "data": {
- "id": "7c3f0355-f59b-4cc6-b13f-e1b5349b5caf",
- "userUuid": "95f71ebc-c8ae-4e25-aded-86e9bbd62966",
- "applicationUserId": "string",
- "institutionId": "postbank-sandbox",
- "state": "551440fc13794010855ad81c8463c926",
- "status": "AWAITING_SCA_METHOD",
- "createdAt": "2021-01-26T23:31:45.443Z",
- "featureScope": [
- "CREATE_DOMESTIC_SINGLE_PAYMENT",
- "EXISTING_PAYMENTS_DETAILS",
- "EXISTING_PAYMENT_INITIATION_DETAILS"
], - "scaMethods": [
- {
- "id": "258211#OPTICAL",
- "type": "CHIP_OTP",
- "description": "Testkarte Hr. Haubach_1, optisch"
}, - {
- "id": "258211#MANUEL",
- "type": "CHIP_OTP",
- "description": "Testkarte Hr. Haubach_1, manuell"
}, - {
- "id": "591655",
- "type": "SMS_OTP",
- "description": "RolandmTAN"
}, - {
- "id": "591656",
- "type": "PUSH_OTP",
- "description": "RSRolandIP2"
}
]
}
}
Used to pass the SCA Code received from the Institution
(and the SCA method selected by the user where multiple SCA methods are supported by the Institution
) in order to complete the embedded authorisation to initiate a payment.
See Embedded Payment Flows for more information about this flow.
Feature: INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT
psu-id | string Conditional. Represents the user's login ID for the |
psu-corporate-id | string Conditional. Represents the user's login ID for the |
psu-ip-address | string Conditional. The IP address of the PSU. |
sub-application | string <uuid> The sub-application ID to which event type is being subscribed to |
userUuid | string <uuid> |
applicationUserId | string Conditional. The user-friendly reference to the |
institutionId required | string Mandatory. The reference to the |
callback | string Optional. The server to redirect the user to after the user complete the authorisation at the |
object (RedirectRequest) Optional. The server to redirect the user to after the user complete the authorisation at the | |
oneTimeToken | boolean Conditional. Used to receive a |
required | object (PaymentRequest) Mandatory. The payment request object defining the details of the payment. |
object (UserCredentials) Conditional. Used to capture the user's credentials to allow them to login to an | |
object (ScaMethod) Conditional. Used to update the authorisation with the sca method of the user's choice for the | |
scaCode | string Conditional. Used to update the authorisation with the sca code received by the user from the |
Ok
Error Response
Berlin Group EUR Single Domestic Payment (SCA Code) Example Request
{- "applicationUserId": "string",
- "institutionId": "postbank-sandbox",
- "scaCode": "325614",
- "paymentRequest": {
- "type": "DOMESTIC_PAYMENT",
- "paymentIdempotencyId": "e4f913909a3d11eabb370242ac130002",
- "reference": "REFERENCE",
- "amount": {
- "amount": 1,
- "currency": "EUR"
}, - "payer": {
- "name": "John Doe",
- "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE12345678901234567890"
}
]
}, - "payee": {
- "name": "Jane Doe",
- "address": {
- "country": "DE"
}, - "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE09876543210987654321"
}
]
}
}
}
Berlin Group EUR Single Domestic Payment (SCA Code) Example Response
{- "meta": {
- "tracingId": "94563449b4634d13b89b8f1c78c21882"
}, - "data": {
- "id": "1767d386-c20a-4136-a311-0a455dd41a78",
- "userUuid": "95f71ebc-c8ae-4e25-aded-86e9bbd62966",
- "applicationUserId": "string",
- "institutionId": "postbank-sandbox",
- "state": "048a1187a9324652bedb6a653211a8a3",
- "status": "AUTHORIZED",
- "createdAt": "2021-01-25T18:32:23.933Z",
- "featureScope": [
- "CREATE_DOMESTIC_SINGLE_PAYMENT",
- "EXISTING_PAYMENT_INITIATION_DETAILS",
- "EXISTING_PAYMENTS_DETAILS"
], - "authorizedAt": "2021-01-25T18:33:18.248Z"
}
}
Used to initiate the authorisation process and direct users to the login screen of their financial Institution in order to give their consent for a payment. This endpoint is used to initiate all the different payment listed below. Based on the type of payment you wish to make, you may be required to provide specific properties in PaymentRequest. First make sure that the payment feature you wish to execute is supported by the bank by checking the features array in GET Institution.
See Redirect Payment Flows for more information about this flow.
Features:
INITIATE_DOMESTIC_PERIODIC_PAYMENT
INITIATE_DOMESTIC_SCHEDULED_PAYMENT
INITIATE_DOMESTIC_SINGLE_INSTANT_PAYMENT
INITIATE_DOMESTIC_SINGLE_PAYMENT
INITIATE_INTERNATIONAL_PERIODIC_PAYMENT
INITIATE_INTERNATIONAL_SCHEDULED_PAYMENT
INITIATE_INTERNATIONAL_SINGLE_PAYMENT
psu-id | string (User Id) Conditional. Represents the user's login ID for the |
psu-corporate-id | string (Corporate User Id) Conditional. Represents the user's login ID for the |
psu-ip-address | string (User IP Address) Conditional. The IP address of the PSU. |
sub-application | string <uuid> The sub-application ID to which event type is being subscribed to |
userUuid | string <uuid> |
applicationUserId | string Conditional. The user-friendly reference to the |
forwardParameters | Array of strings Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect. |
institutionId required | string Mandatory. The reference to the |
callback | string Optional. The URL to redirect the user to after the user complete the authorisation at the |
object (RedirectRequest) Optional. The server to redirect the user to after the user complete the authorisation at the | |
oneTimeToken | boolean Conditional. Used to receive a |
required | object (PaymentRequest) Mandatory. The payment request object defining the details of the payment. |
Created
Error Response
EUR Single Domestic Example Request
{- "applicationUserId": "string",
- "institutionId": "bpm-sandbox",
- "paymentRequest": {
- "paymentIdempotencyId": "234g87t58tgeuo848wudjew489",
- "payer": {
- "name": "John Doe",
- "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE12345678901234567890"
}
]
}, - "amount": {
- "amount": 1,
- "currency": "EUR"
}, - "reference": "Bill Payment",
- "type": "DOMESTIC_PAYMENT",
- "payee": {
- "name": "Jane Doe",
- "address": {
- "country": "BE"
}, - "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "BE12345678901234"
}
]
}
}
}
EUR Single Domestic Example Response
{- "meta": {
- "tracingId": "a3d09f97bea244e2bb8be0bffbe53f81"
}, - "data": {
- "id": "cae22f3d-1033-4ba6-95ae-0d8ca193b090",
- "userUuid": "5350782b-60f3-489e-aae5-a24d8d679a07",
- "applicationUserId": "string",
- "institutionId": "bpm-sandbox",
- "status": "AWAITING_AUTHORIZATION",
- "createdAt": "2021-06-10T11:47:12.887Z",
- "featureScope": [
- "EXISTING_PAYMENTS_DETAILS",
- "CREATE_DOMESTIC_SINGLE_PAYMENT",
- "EXISTING_PAYMENT_INITIATION_DETAILS"
], - "state": "6a5f69be6a084b5c8c1becac88d45c95",
- "institutionConsentId": "79cee256-077f-4e11-a307-43892646a4a6",
}
}
Used to continue the authorisation process and for any Institution
that contains the INITIATE_PRE_AUTHORISATION
feature and direct user to the login screen of their financial institution in order to give consent to initiate a payment.
See Redirect Payment Flows for more information about this flow.
Feature: INITIATE_PRE_AUTHORISATION
psu-id | string (User Id) Conditional. Represents the user's login ID for the |
psu-corporate-id | string (Corporate User Id) Conditional. Represents the user's login ID for the |
psu-ip-address | string (User IP Address) Conditional. The IP address of the PSU. |
consent required | string Mandatory. The Example: {consentToken} |
userUuid | string <uuid> |
applicationUserId | string Conditional. The user-friendly reference to the |
forwardParameters | Array of strings Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect. |
institutionId required | string Mandatory. The reference to the |
callback | string Optional. The URL to redirect the user to after the user complete the authorisation at the |
object (RedirectRequest) Optional. The server to redirect the user to after the user complete the authorisation at the | |
oneTimeToken | boolean Conditional. Used to receive a |
required | object (PaymentRequest) Mandatory. The payment request object defining the details of the payment. |
Ok
Error Response
Berlin Group EUR Single Domestic Payment Example Request
{- "applicationUserId": "string",
- "institutionId": "n26",
- "paymentRequest": {
- "paymentIdempotencyId": "234g87t58tgeuo848wudjew489",
- "payer": {
- "name": "John Doe",
- "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "DE12345678901234567890"
}
]
}, - "amount": {
- "amount": 1,
- "currency": "EUR"
}, - "reference": "Bill Payment",
- "type": "DOMESTIC_PAYMENT",
- "payee": {
- "name": "Jane Doe",
- "address": {
- "country": "BE"
}, - "accountIdentifications": [
- {
- "type": "IBAN",
- "identification": "BE12345678901234"
}
]
}
}
}
Berlin Group EUR Single Domestic Payment Example Response
{- "meta": {
- "tracingId": "54ec0645a5b444c4a70c61357e9ad887"
}, - "data": {
- "id": "53ff00d0-91dd-417d-880b-cdd7c50090ed",
- "userUuid": "e2578545-27a4-4edf-983f-5d33c2d7b559",
- "applicationUserId": "string",
- "institutionId": "n26",
- "state": "4399535ee4de46238fce108a95669848",
- "status": "AWAITING_DECOUPLED_AUTHORIZATION",
- "createdAt": "2021-06-10T09:54:46.669Z",
- "featureScope": [
- "INITIATE_PRE_AUTHORISATION",
- "CREATE_DOMESTIC_SINGLE_PAYMENT",
- "EXISTING_PAYMENTS_DETAILS"
], - "authorizedAt": "2021-06-10T09:55:22.359Z",
- "institutionConsentId": "a9582f8e-08be-4cca-9f01-1ad3be96532d"
}
}
Used to initiate the pre-authorisation process for any Institution
that contains the INITIATE_PRE_AUTHORISATION
feature to authenticate the user.
Feature: INITIATE_PRE_AUTHORISATION
psu-id | string Conditional. Represents the user's login ID for the |
psu-corporate-id | string Conditional. Represents the user's login ID for the |
psu-ip-address | string Conditional. The IP address of the PSU. |
sub-application | string <uuid> The sub-application ID to which event type is being subscribed to |