{ "openapi": "3.0.1", "info": { "description": "The Yapily API enables connections between your application and users' banks. For more information check out our [documentation](https://docs.yapily.com/).

In particular, make sure to view our [Getting Started](https://docs.yapily.com/pages/home/getting-started/) steps if this is your first time here.

While testing the API, our list of [sandbox credentials](https://docs.yapily.com/pages/key-concepts/sandbox-credentials/) maybe useful.", "title": "Yapily API", "version": "12.3.1", "contact": { "name": "Yapily Support", "url": "https://docs.yapily.com/pages/resources/support/", "email": "support@yapily.com" } }, "servers": [ { "url": "https://api.yapily.com" } ], "security": [ { "basicAuth": [ ] } ], "tags": [ { "description": "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.", "name": "Application" }, { "description": "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`.", "name": "Users" }, { "description": "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:", "name": "Institutions" }, { "description": "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.", "name": "Consents" }, { "description": "Before calling [Financial Data](#yapily-api-financial-data) or [Payments](#yapily-api-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.", "name": "Authorisations" }, { "description": "In order to access a user's Financial Data, you are required to request an [Authorisation](#tag/Authorisations) from the user to share the account information the bank has. Once a `consent-token` is obtained, you can call the necessary Financial Data endpoint(s) to retrieve the user's data.", "name": "Financial Data" }, { "description": "In order to make a Payment on behalf of a user, you are required to request an [Authorisation](#tag/Authorisations) from the user to authorise the user's account to make the payment from. Once a `consent-token` is obtained, you can call the necessary Payments endpoint(s) to execute a payment.", "name": "Payments" }, { "description": "The Notifications endpoints provide an interactive way for user to receive notifications according to different event-types. This feature is currently in private beta. Please reach out if you require access. \n\n", "name": "Notifications" }, { "description": "Variable Recurring Payments enables transfer of money between accounts held by the same person or transfer of money for business payments.

In order to make Sweeping Variable Recurring Payments on behalf of a user, you are required to request an [Consent](#tag/Authorisations) from the user by calling the Sweeping Consent endpoint to authorise the user's account to make the payment. Once a `consent-token` is obtained, you can call the Payments endpoint to execute the Sweeping Variable Recurring Payments transaction. Before executing the payment, you have the option to confirm availability of funds in the user's account by calling the Funds Confirmation endpoint.

See [VRP Payments](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/variable-recurring-payments/) for more information. ", "name": "Variable Recurring Payments" }, { "description": "Hosted Payment Pages endpoints for payments products", "name": "Hosted Payment Pages" }, { "description": "Hosted Consent Pages endpoints for data products", "name": "Hosted Consent Pages" }, { "description": "The constraints endpoints can be used to retrieve institution specific data requirements and rules that will apply when performing other operations.", "name": "Constraints" }, { "description": "Application Management endpoints help with creating and managing client sub-applications.", "name": "Application Management" }, { "description": "Data Plus endpoints enable our customers to enrich transaction data. ", "name": "Data Plus" }, { "description": "Webhook endpoints", "name": "Webhooks" }, { "description": "Application Beneficiaries Endpoints", "name": "Application Beneficiaries" }, { "description": "User Beneficiaries Endpoints", "name": "User Beneficiaries" } ], "x-tagGroups": [ { "name": "Endpoints", "tags": [ "Application", "Application Management", "Application Beneficiaries", "Users", "User Beneficiaries", "Institutions", "Consents", "Authorisations", "Financial Data", "Payments", "Notifications", "Variable Recurring Payments", "Hosted Payment Pages", "Hosted Consent Pages", "Constraints", "Data Plus", "Webhooks" ] } ], "paths": { "/account-auth-requests": { "x-yapily-features": [ "INITIATE_ACCOUNT_REQUEST" ], "patch": { "description": "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](https://docs.yapily.com/pages/key-concepts/account-data/account-consents/#re-authorisation) for more information.", "operationId": "reAuthoriseAccount", "parameters": [ { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "OBIE Example Response": { "$ref": "#/components/examples/obie-example-acc-auth-response-patch" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfAccountAuthorisationResponse" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Re-authorise Account Consent", "tags": [ "Authorisations" ] }, "post": { "description": "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](https://docs.yapily.com/pages/key-concepts/account-data/account-authorisation/redirect-account-flows/) for more information about this flow.

Feature: `INITIATE_ACCOUNT_REQUEST`", "operationId": "initiateAccountRequest", "parameters": [ { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "OBIE Example Request": { "$ref": "#/components/examples/obie-example-acc-auth-request" } }, "schema": { "$ref": "#/components/schemas/AccountAuthorisationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "OBIE Example Response": { "$ref": "#/components/examples/obie-example-acc-auth-response-post" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfAccountAuthorisationResponse" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Account Authorisation", "tags": [ "Authorisations" ] }, "put": { "description": "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](https://docs.yapily.com/pages/key-concepts/account-data/account-authorisation/redirect-account-flows/) for more information about this flow.

Features: ", "operationId": "updatePreAuthoriseAccountConsent", "parameters": [ { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group Example Request": { "$ref": "#/components/examples/berlin-group-example-acc-auth-request" } }, "schema": { "$ref": "#/components/schemas/AccountAuthorisationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "OBIE Example Response": { "$ref": "#/components/examples/obie-example-acc-auth-response-put" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfAccountAuthorisationResponse" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Update Account Pre-authorisation", "tags": [ "Authorisations" ] } }, "/accounts": { "x-yapily-features": [ "ACCOUNTS", "ACCOUNTS_WITHOUT_BALANCE" ], "get": { "description": "Returns all accounts and balances for the end user associated with the presented consent token.

Feature: `ACCOUNTS`", "operationId": "getAccounts", "parameters": [ { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "OBIE Example Response": { "$ref": "#/components/examples/obie-example-accounts-response" } }, "schema": { "$ref": "#/components/schemas/AccountApiListResponse" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Accounts", "tags": [ "Financial Data" ] } }, "/accounts/{accountId}": { "x-yapily-features": [ "ACCOUNT", "ACCOUNT_WITHOUT_BALANCE" ], "get": { "description": "Returns the account and balance information for a user's specified account.

Feature: `ACCOUNT`", "operationId": "getAccount", "parameters": [ { "description": "__Mandatory__. The account Id of the user's bank account.", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "OBIE Example Response": { "$ref": "#/components/examples/obie-example-account-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfAccount" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Account", "tags": [ "Financial Data" ] } }, "/accounts/{accountId}/balances": { "x-yapily-features": [ "ACCOUNT_BALANCES" ], "get": { "description": "Returns the balance for the end user associated with the presented consent token.

Feature: `ACCOUNT_BALANCES`", "operationId": "getAccountBalances", "parameters": [ { "description": "__Mandatory__. The account Id of the user's bank account.", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example response": { "$ref": "#/components/examples/example-acc-balance-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfBalances" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Account Balances", "tags": [ "Financial Data" ] } }, "/accounts/{accountId}/beneficiaries": { "x-yapily-features": [ "ACCOUNT_BENEFICIARIES" ], "get": { "description": "Returns all the beneficiaries of a user's account.

Feature: `ACCOUNT_BENEFICIARIES`", "operationId": "getBeneficiaries", "parameters": [ { "description": "__Mandatory__. The account Id of the user's bank account.", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "OBIE Example Response": { "$ref": "#/components/examples/obie-example-acc-beneficiaries-response" } }, "schema": { "$ref": "#/components/schemas/ApiListResponseOfBeneficiary" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Account Beneficiaries", "tags": [ "Financial Data" ] } }, "/accounts/{accountId}/direct-debits": { "x-yapily-features": [ "ACCOUNT_DIRECT_DEBITS" ], "get": { "description": "Returns the list of direct debits for an account.

Feature: `ACCOUNT_DIRECT_DEBITS`", "operationId": "getAccountDirectDebits", "parameters": [ { "description": "__Mandatory__. The account Id of the user's bank account.", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" }, { "description": "__Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "OBIE Example Response": { "$ref": "#/components/examples/obie-example-acc-direct-debits-response" } }, "schema": { "$ref": "#/components/schemas/ApiListResponseOfDirectDebitResponse" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Account Direct Debits", "tags": [ "Financial Data" ] } }, "/accounts/{accountId}/periodic-payments": { "x-yapily-features": [ "ACCOUNT_PERIODIC_PAYMENTS" ], "get": { "description": "Returns the list of periodic payments (standing orders in the UK) for an account.

Feature: `ACCOUNT_PERIODIC_PAYMENTS`", "operationId": "getAccountPeriodicPayments", "parameters": [ { "description": "__Mandatory__. The account Id of the user's bank account.", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" }, { "description": "__Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "OBIE Example Response": { "$ref": "#/components/examples/obie-example-acc-periodic-payments-response" } }, "schema": { "$ref": "#/components/schemas/ApiListResponseOfPaymentResponse" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Account Periodic Payments", "tags": [ "Financial Data" ] } }, "/accounts/{accountId}/scheduled-payments": { "x-yapily-features": [ "ACCOUNT_SCHEDULED_PAYMENTS" ], "get": { "description": "Returns the list of scheduled payments for an account.

Feature: `ACCOUNT_SCHEDULED_PAYMENTS`", "operationId": "getAccountScheduledPayments", "parameters": [ { "description": "__Mandatory__. The account Id of the user's bank account.", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" }, { "description": "__Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "OBIE Example Response": { "$ref": "#/components/examples/obie-example-acc-scheduled-payments-response" } }, "schema": { "$ref": "#/components/schemas/ApiListResponseOfPaymentResponse" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Account Scheduled Payments", "tags": [ "Financial Data" ] } }, "/accounts/{accountId}/statements": { "x-yapily-features": [ "ACCOUNT_STATEMENTS" ], "get": { "description": "Returns the list of statements for an account.

Feature: `ACCOUNT_STATEMENTS`", "operationId": "getStatements", "parameters": [ { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The account Id of the user's bank account.", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" }, { "description": "__Optional__. Returned transactions will be on or after this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ). ", "in": "query", "name": "from", "required": false, "schema": { "type": "string" } }, { "description": "__Optional__. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).", "in": "query", "name": "before", "required": false, "schema": { "type": "string" } }, { "description": "__Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "description": "__Optional__. Sort transaction records by date ascending with 'date' or descending with '-date'. The default sort order is descending", "in": "query", "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/SortEnum" } }, { "description": "__Optional__. The number of transaction records to be skipped. Used primarily with paginated results.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/account-statements-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiListResponseOfAccountStatement" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Account Statements", "tags": [ "Financial Data" ] } }, "/accounts/{accountId}/statements/{statementId}": { "x-yapily-features": [ "ACCOUNT_STATEMENT" ], "get": { "description": "Returns a statement for an account.

Feature: `ACCOUNT_STATEMENT`", "operationId": "getStatement", "parameters": [ { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The account Id of the user's bank account.", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The statement Id of the statement file.", "in": "path", "name": "statementId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "description": "Example Response", "value": { "meta": { "tracingId": "8bacaae3025647efa1891157993e32fb" }, "data": { "id": "700014000000000000000002", "startDateTime": "2017-08-01T00:00:00Z", "endDateTime": "2017-08-31T23:59:59Z", "creationDateTime": "2017-09-01T00:00:00Z" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfAccountStatement" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Account Statement", "tags": [ "Financial Data" ] } }, "/accounts/{accountId}/statements/{statementId}/file": { "x-yapily-features": [ "ACCOUNT_STATEMENT_FILE" ], "get": { "description": "Returns a PDF file of a statement for an account.

Feature: `ACCOUNT_STATEMENT_FILE`", "operationId": "getStatementFile", "parameters": [ { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The account Id of the user's bank account.", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The statement Id of the statement file.", "in": "path", "name": "statementId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Account Statement File", "tags": [ "Financial Data" ] } }, "/accounts/{accountId}/transactions": { "x-yapily-features": [ "ACCOUNT_TRANSACTIONS", "ACCOUNT_TRANSACTIONS_WITH_MERCHANT" ], "get": { "description": "Returns the account transactions for an account.

Feature: `ACCOUNT_TRANSACTIONS`", "operationId": "getTransactions", "parameters": [ { "description": "__Mandatory__. The account Id of the user's bank account.", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" }, { "description": "__Optional__. Returned transactions will be on or after this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ). ", "in": "query", "name": "from", "required": false, "schema": { "type": "string" } }, { "description": "__Optional__. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).", "in": "query", "name": "before", "required": false, "schema": { "type": "string" } }, { "description": "__Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "description": "__Optional__. Sort transaction records by date ascending with 'date' or descending with '-date'. The default sort order is descending", "in": "query", "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/SortEnum" } }, { "description": "__Optional__. The number of transaction records to be skipped. Used primarily with paginated results.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "description": "__Optional__. This property is not currently in use.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/account-transactions-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiListResponseOfTransaction" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Account Transactions", "tags": [ "Financial Data" ] } }, "/bulk-payment-auth-requests": { "x-yapily-features": [ "INITIATE_BULK_PAYMENT" ], "post": { "description": "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](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/bulk-payments/) for more information.

See [Redirect Payment Flows](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/redirect-payment-flows/) for more information about this flow.

Feature: `INITIATE_BULK_PAYMENT`", "operationId": "createBulkPaymentAuthorisation", "parameters": [ { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "UK Bulk Payment Example Request": { "$ref": "#/components/examples/uk-bulk-payment-auth-example-request" } }, "schema": { "$ref": "#/components/schemas/BulkPaymentAuthorisationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "UK Bulk Payment Example Response": { "$ref": "#/components/examples/uk-bulk-payment-auth-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfPaymentAuthorisationRequestResponse" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Bulk Payment Authorisation", "tags": [ "Authorisations" ] } }, "/bulk-payments": { "x-yapily-features": [ "CREATE_BULK_PAYMENT" ], "post": { "description": "Creates a bulk payment after obtaining the user's authorisation.

Feature: `CREATE_BULK_PAYMENT`", "operationId": "createBulkPayment", "parameters": [ { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "UK Bulk Payment Example Request": { "$ref": "#/components/examples/uk-bulk-payment-example-request" } }, "schema": { "$ref": "#/components/schemas/SubmitBulkPaymentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "UK Bulk Payment Example Response": { "$ref": "#/components/examples/uk-bulk-payment-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfCreateBulkPaymentRequest" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Bulk Payment", "tags": [ "Payments" ] } }, "/bulk-payments/{bulkPaymentId}": { "get": { "description": "Returns the bulk file status of the bulk payment for given bulkPaymentId", "summary": "Get Bulk Payment File Status", "tags": [ "Payments" ], "operationId": "getBulkPaymentStatus", "parameters": [ { "schema": { "type": "string" }, "in": "header", "name": "consent", "description": "__Mandatory__. The `consent token` containing the user's authorisation to make the request.", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "bulkPaymentId", "description": "__Mandatory__. Bulk payment id returned when bulk payment request was submitted.", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "tracingId": { "type": "string" } } }, "data": { "type": "object", "properties": { "id": { "description": "Unique identifier of the Bulk Payment", "type": "string" }, "consentId": { "description": "Identification of the consent.", "type": "string" }, "statusDetails": { "type": "object", "properties": { "status": { "type": "string", "description": "Bulk file status. Enum: `COMPLETED` `PENDING` `FAILED` `UNKNOWN`\nThese values are subject to change." }, "updatedAt": { "type": "string", "format": "date-time" } } }, "createdAt": { "type": "string", "format": "date-time" } } } } }, "examples": { "Successful 200 OK": { "value": { "meta": { "tracingId": "27b47dca-fb0f-4448-b470-1cd2d5516d0f" }, "data": { "id": "76ad88c7-6e99-4a16-a277-e428a73d1e86", "consentId": "5daeb980-5ff5-49db-b7a0-e93dd9c93533", "statusDetails": { "status": "COMPLETED", "updatedAt": "2024-07-25T18:14:52.672Z" }, "createdAt": "2024-07-25T18:14:52.672Z" } } } } } } }, "400": { "description": "Required parameter missing or invalid", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "404": { "description": "Bulk payment not found for provided id", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/404-error-response" } } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } } } }, "/bulk-payments/{bulkPaymentId}/details": { "x-yapily-features": [ "EXISTING_BULK_PAYMENT_DETAILS" ], "get": { "description": "Retrieve details of each payment submitted for a given bulkPaymentId.

Feature: `EXISTING_BULK_PAYMENT_DETAILS`", "operationId": "getBulkPaymentDetailsById", "summary": "Get individual payment details of the Bulk Payment transaction", "tags": [ "Payments" ], "parameters": [ { "schema": { "type": "string" }, "in": "header", "name": "consent", "description": "__Mandatory__. The `consent token` containing the user's authorisation to make the request.", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "bulkPaymentId", "description": "__Mandatory__. Bulk payment id returned when bulk payment request was submitted", "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/BulkPaymentDetailsResponse" }, "examples": { "Successful 200 OK": { "$ref": "#/components/examples/bulk-payment-details-by-id-response" } } } } }, "400": { "description": "Required parameter missing or invalid", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "404": { "description": "Bulk payment not found for provided id", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/404-error-response" } } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } } } }, "/consent-auth-code": { "post": { "description": "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`.", "operationId": "createConsentWithCode", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentAuthCodeRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/consent-auth-code-example-response" } }, "schema": { "$ref": "#/components/schemas/Consent" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Exchange OAuth2 Code", "tags": [ "Consents" ] } }, "/consent-one-time-token": { "post": { "description": "Exchange a One-time-token for the consent token", "operationId": "getConsentBySingleAccessConsent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OneTimeTokenRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/consent-one-time-token-example-response" } }, "schema": { "$ref": "#/components/schemas/Consent" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Exchange One Time Token", "tags": [ "Consents" ] } }, "/consents": { "get": { "description": "Used to retrieve all the consents created for each user within an application. At least one of the following filters needs to be applied: filter[applicationUserId], filter[userUuid]=, limit=. ", "operationId": "getConsents", "parameters": [ { "description": "__Optional__. Filter records based on the list of `applicationUserId` users provided. At least one of these filters filter[applicationUserId], filter[userUuid]=, limit= must be provided.", "in": "query", "name": "filter[applicationUserId]", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "description": "__Optional__. Filter records based on the list of `userUuid` users provided. At least one of these filters filter[applicationUserId], filter[userUuid]=, limit= must be provided.", "in": "query", "name": "filter[userUuid]", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "description": "__Optional__. Filter records based on the list of `Institution` provided.", "in": "query", "name": "filter[institution]", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "description": "__Optional__. Filter records based on the list of `Consent` [statuses](https://docs.yapily.com/api/reference/#operation/getConsents!c=200&path=data/status&t=response).", "in": "query", "name": "filter[status]", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, { "description": "__Optional__. Returned transactions will be on or after this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ). ", "in": "query", "name": "from", "required": false, "schema": { "type": "string" } }, { "description": "__Optional__. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).", "in": "query", "name": "before", "required": false, "schema": { "type": "string" } }, { "description": "__Optional__. The maximum number of transaction records to be returned. Must be between 1 and 1000. At least one of these filters filter[applicationUserId], filter[userUuid]=, limit= must be provided.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "description": "__Optional__. The number of transaction records to be skipped. Used primarily with paginated results.", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/consents-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiListResponseOfConsent" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Consents", "tags": [ "Consents" ] } }, "/consents/{consentId}": { "delete": { "description": "Delete a consent using the consent Id", "operationId": "delete", "parameters": [ { "description": "__Mandatory__. The consent Id of the `Consent` to update.", "in": "path", "name": "consentId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "description": "__Optional__. Whether to force the deletion.", "in": "query", "name": "forceDelete", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/consent-delete-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfConsentDeleteResponse" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Delete Consent", "tags": [ "Consents" ] }, "get": { "description": "Get consent using the consent Id", "operationId": "getConsentById", "parameters": [ { "description": "__Mandatory__. The consent Id of the `Consent` to update.", "in": "path", "name": "consentId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/consent-get-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfConsent" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Consent", "tags": [ "Consents" ] } }, "/consents/{consentId}/extend": { "post": { "description": "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.", "operationId": "extendConsent", "x-beta": true, "parameters": [ { "description": "__Mandatory__. The consent Id of the `Consent` to update.", "in": "path", "name": "consentId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Request": { "$ref": "#/components/examples/consent-extend-example-request" } }, "schema": { "$ref": "#/components/schemas/ExtendConsentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/consent-get-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfConsent" } } }, "description": "Created" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/extend-consent-error-response-code-400" } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response. The supplied lastConfirmedAt date, Consent type, or Consent status is invalid." }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response" } }, "summary": "Extend Consent", "tags": [ "Consents" ] } }, "/embedded-account-auth-requests": { "x-yapily-features": [ "INITIATE_EMBEDDED_ACCOUNT_REQUEST" ], "post": { "description": "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](https://docs.yapily.com/pages/key-concepts/account-data/account-authorisation/embedded-account-flows/) for more information about this flow.

Feature: `INITIATE_EMBEDDED_ACCOUNT_REQUEST`", "operationId": "initiateEmbeddedAccountRequest", "parameters": [ { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group Example Request": { "$ref": "#/components/examples/berlin-group-example-embedded-acc-auth-request" } }, "schema": { "$ref": "#/components/schemas/EmbeddedAccountAuthorisationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group (Multiple SCA Methods) Example Response": { "$ref": "#/components/examples/berlin-group-multiple-sca-methods-example-response" }, "Berlin Group (Single SCA Method) Example Response": { "$ref": "#/components/examples/berlin-group-single-sca-method-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfEmbeddedAccountAuthorisationResponse" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Embedded Account Authorisation", "tags": [ "Authorisations" ] } }, "/embedded-account-auth-requests/{consentId}": { "put": { "description": "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](https://docs.yapily.com/pages/key-concepts/account-data/account-authorisation/embedded-account-flows/) for more information about this flow.

Feature: `INITIATE_EMBEDDED_ACCOUNT_REQUEST`", "operationId": "updateEmbeddedAccountRequest", "parameters": [ { "description": "__Mandatory__. The consent Id of the `Consent` to update.", "in": "path", "name": "consentId", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group (SCA Code) Example Request": { "$ref": "#/components/examples/berlin-group-sca-code-example-request" }, "Berlin Group (Selected SCA Method) Example Request": { "$ref": "#/components/examples/berlin-group-selected-sca-method-example-request" } }, "schema": { "$ref": "#/components/schemas/EmbeddedAccountAuthorisationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group (SCA Code) Example Response": { "$ref": "#/components/examples/berlin-group-sca-code-example-response" }, "Berlin Group (Selected SCA Method) Example Response": { "$ref": "#/components/examples/berlin-group-selected-sca-method-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfEmbeddedAccountAuthorisationResponse" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Update Embedded Account Authorisation", "tags": [ "Authorisations" ] } }, "/embedded-bulk-payment-auth-requests": { "x-yapily-features": [ "INITIATE_EMBEDDED_BULK_PAYMENT" ], "post": { "description": "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](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/bulk-payments/) for more information.

See [Embedded Payment Flows](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/embedded-payment-flows/) for more information about this flow.

Feature: `INITIATE_EMBEDDED_BULK_PAYMENT`", "operationId": "createEmbeddedBulkPaymentAuthorisation", "parameters": [ { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group EUR Embedded Bulk Payment Example Request": { "$ref": "#/components/examples/berlin-group-eur-embedded-bulk-payment-example-request" } }, "schema": { "$ref": "#/components/schemas/BulkPaymentEmbeddedAuthorisationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group EUR Embedded Bulk Payment Example Response": { "$ref": "#/components/examples/berlin-group-eur-embedded-bulk-payment-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfPaymentEmbeddedAuthorisationRequestResponse" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Embedded Bulk Payment Authorisation", "tags": [ "Authorisations" ] } }, "/embedded-bulk-payment-auth-requests/{consentId}": { "put": { "description": "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](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/bulk-payments/) for more information.

See [Embedded Payment Flows](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/embedded-payment-flows/) for more information about this flow.

Feature: `INITIATE_EMBEDDED_BULK_PAYMENT`", "operationId": "updateEmbeddedBulkPaymentAuthorisation", "parameters": [ { "description": "__Mandatory__. The consent Id of the `Consent` to update.", "in": "path", "name": "consentId", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group EUR Embedded Bulk Payment (SCA Code) Example Request": { "$ref": "#/components/examples/berlin-group-eur-embedded-bulk-payment-sca-code-example-request" } }, "schema": { "$ref": "#/components/schemas/BulkPaymentEmbeddedAuthorisationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group EUR Embedded Bulk Payment (SCA Code) Example Response": { "$ref": "#/components/examples/berlin-group-eur-embedded-bulk-payment-sca-code-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfPaymentEmbeddedAuthorisationRequestResponse" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Update Embedded Bulk Payment Authorisation", "tags": [ "Authorisations" ] } }, "/embedded-payment-auth-requests": { "x-yapily-features": [ "INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT" ], "post": { "description": "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](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/embedded-payment-flows/) for more information about this flow.

Feature: `INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT`", "operationId": "createEmbeddedPaymentAuthorisation", "parameters": [ { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group EUR Single Domestic Payment Example Request": { "$ref": "#/components/examples/berlin-group-eur-single-domestic-embedded-payment-example-request" } }, "schema": { "$ref": "#/components/schemas/PaymentEmbeddedAuthorisationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group EUR Single Domestic Payment Example Response": { "$ref": "#/components/examples/berlin-group-eur-single-domestic-embedded-payment-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfPaymentEmbeddedAuthorisationRequestResponse" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Embedded Payment Authorisation", "tags": [ "Authorisations" ] } }, "/embedded-payment-auth-requests/{consentId}": { "put": { "description": "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](https://docs.yapily.com/guides/payments/payment-authorisation-flows/embedded/) for more information about this flow.

Feature: `INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT`", "operationId": "updateEmbeddedPaymentAuthorisation", "parameters": [ { "description": "__Mandatory__. The consent Id of the `Consent` to update.", "in": "path", "name": "consentId", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group EUR Single Domestic Payment (SCA Code) Example Request": { "$ref": "#/components/examples/berlin-group-eur-single-domestic-payment-sca-code-example-request" }, "Berlin Group EUR Single Domestic Payment (Selected SCA Method) Example Request": { "$ref": "#/components/examples/berlin-group-eur-single-domestic-payment-selected-sca-method-example-request" } }, "schema": { "$ref": "#/components/schemas/PaymentEmbeddedAuthorisationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group EUR Single Domestic Payment (SCA Code) Example Response": { "$ref": "#/components/examples/berlin-group-eur-single-domestic-payment-sca-code-example-response" }, "Berlin Group EUR Single Domestic Payment (Selected SCA Method) Example Response": { "$ref": "#/components/examples/berlin-group-eur-single-domestic-payment-selected-sca-method-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfPaymentEmbeddedAuthorisationRequestResponse" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Update Embedded Payment Authorisation", "tags": [ "Authorisations" ] } }, "/identity": { "x-yapily-features": [ "IDENTITY" ], "get": { "description": "Returns the identity information for an account.

Feature: `IDENTITY`", "operationId": "getIdentity", "parameters": [ { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/identity-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfIdentity" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Identity", "tags": [ "Financial Data" ] } }, "/institutions": { "get": { "description": "Used to retrieve all `Institutions` within an application", "operationId": "getInstitutions", "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/institutions-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiListResponseOfInstitution" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Institutions", "tags": [ "Institutions" ] } }, "/institutions/{institutionId}": { "get": { "description": "Used to retrieves details of a specific `Institution` within an application", "operationId": "getInstitution", "parameters": [ { "description": "__Mandatory__. The Yapily institution Id for the `Institution`.", "in": "path", "name": "institutionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/institution-example-response" } }, "schema": { "$ref": "#/components/schemas/Institution" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Institution", "tags": [ "Institutions" ] } }, "/payment-auth-requests": { "x-yapily-features": [ "INITIATE_DOMESTIC_PERIODIC_PAYMENT", "INITIATE_DOMESTIC_SCHEDULED_PAYMENT", "INITIATE_DOMESTIC_SINGLE_INSTANT_PAYMENT", "INITIATE_DOMESTIC_SINGLE_PAYMENT", "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT", "INITIATE_INTERNATIONAL_PERIODIC_PAYMENT", "INITIATE_INTERNATIONAL_SCHEDULED_PAYMENT", "INITIATE_INTERNATIONAL_SINGLE_PAYMENT", "READ_DOMESTIC_PERIODIC_PAYMENT_REFUND", "READ_DOMESTIC_SCHEDULED_REFUND", "READ_DOMESTIC_SINGLE_REFUND", "READ_INTERNATIONAL_SCHEDULED_REFUND", "READ_INTERNATIONAL_SINGLE_REFUND" ], "post": { "description": "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](https://docs.yapily.com/api/reference/#operation/createPaymentAuthorisation!path=paymentRequest&t=request). First make sure that the payment feature you wish to execute is supported by the bank by checking the features array in [GET Institution](https://docs.yapily.com/api/reference/#operation/getInstitution).

See [Redirect Payment Flows](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/redirect-payment-flows/) for more information about this flow.

Features:", "operationId": "createPaymentAuthorisation", "parameters": [ { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "title": "User Id", "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "title": "Corporate User Id", "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "title": "User IP Address", "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "EUR Single Domestic Example Request": { "$ref": "#/components/examples/eur-single-domestic-payment-auth-example-request" }, "GBP Single Domestic Example Request": { "$ref": "#/components/examples/gbp-single-domestic-payment-auth-example-request" } }, "schema": { "$ref": "#/components/schemas/PaymentAuthorisationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "EUR Single Domestic Example Response": { "$ref": "#/components/examples/eur-single-domestic-payment-auth-example-response" }, "GBP Single Domestic Example Response": { "$ref": "#/components/examples/gbp-single-domestic-payment-auth-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfPaymentAuthorisationRequestResponse" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Payment Authorisation", "tags": [ "Authorisations" ] }, "put": { "description": "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](https://docs.yapily.com/pages/key-concepts/payments/payment-authorisation/redirect-payment-flows/) for more information about this flow.

Feature: `INITIATE_PRE_AUTHORISATION`", "operationId": "updatePaymentAuthorisation", "parameters": [ { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "title": "User Id", "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "title": "Corporate User Id", "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "title": "User IP Address", "type": "string" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group EUR Single Domestic Payment Example Request": { "$ref": "#/components/examples/berlin-group-eur-single-domestic-payment-example-request" } }, "schema": { "$ref": "#/components/schemas/PaymentAuthorisationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group EUR Single Domestic Payment Example Response": { "$ref": "#/components/examples/berlin-group-eur-single-domestic-payment-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfPaymentAuthorisationRequestResponse" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Update Payment Pre-authorisation", "tags": [ "Authorisations" ] } }, "/payments": { "x-yapily-features": [ "CREATE_DOMESTIC_PERIODIC_PAYMENT", "CREATE_DOMESTIC_SCHEDULED_PAYMENT", "CREATE_DOMESTIC_SINGLE_INSTANT_PAYMENT", "CREATE_DOMESTIC_SINGLE_PAYMENT", "CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT", "CREATE_INTERNATIONAL_PERIODIC_PAYMENT", "CREATE_INTERNATIONAL_SCHEDULED_PAYMENT", "CREATE_INTERNATIONAL_SINGLE_PAYMENT", "PERIODIC_PAYMENT_FREQUENCY_EXTENDED" ], "post": { "description": "Creates a payment after obtaining the user's authorisation.

Features:", "operationId": "createPayment", "parameters": [ { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "title": "User Id", "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "title": "Corporate User Id", "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "title": "User IP Address", "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "EUR Domestic Single Payment Example Request": { "$ref": "#/components/examples/eur-domestic-single-payment-example-request" }, "GBP Domestic Single Payment Example Request": { "$ref": "#/components/examples/gbp-domestic-single-payment-example-request" } }, "schema": { "$ref": "#/components/schemas/PaymentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "EUR Domestic Single Payment Example Response": { "$ref": "#/components/examples/eur-domestic-single-payment-example-response" }, "GBP Domestic Single Payment Example Response": { "$ref": "#/components/examples/gbp-domestic-single-payment-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfPaymentResponse" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Payment", "tags": [ "Payments" ] } }, "/payments/{paymentId}/details": { "x-yapily-features": [ "EXISTING_PAYMENTS_DETAILS" ], "get": { "description": "Returns the details of a payment.

Most commonly used to check for payment status updates.

Feature: `EXISTING_PAYMENTS_DETAILS`", "operationId": "getPayments", "parameters": [ { "description": "__Mandatory__. The payment Id of the payment.", "in": "path", "name": "paymentId", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "title": "User Id", "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "title": "Corporate User Id", "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "title": "User IP Address", "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "EUR Single Domestic Payment Example Response": { "$ref": "#/components/examples/eur-single-domestic-payment-details-example-response" }, "GBP Single Domestic Payment Example Response": { "$ref": "#/components/examples/gbp-single-domestic-payment-details-example-response" }, "UK Bulk Payment Example Response": { "$ref": "#/components/examples/uk-bulk-payment-details-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfPaymentResponses" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Payment Details", "tags": [ "Payments" ] } }, "/pre-auth-requests": { "x-yapily-features": [ "INITIATE_ONETIME_PRE_AUTHORISATION", "INITIATE_PRE_AUTHORISATION", "INITIATE_PRE_AUTHORISATION_ACCOUNTS", "INITIATE_PRE_AUTHORISATION_PAYMENTS" ], "post": { "description": "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`", "operationId": "createPreAuthorisationRequest", "parameters": [ { "description": "__Optional__. Used to obtain the raw request and response to and from the Institution.", "in": "query", "name": "raw", "required": false, "schema": { "type": "boolean" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group (AIS) Example Request": { "$ref": "#/components/examples/berlin-group-ais-pre-auth-example-request" }, "Berlin Group (PIS) Example Request": { "$ref": "#/components/examples/berlin-group-pis-pre-auth-example-request" } }, "schema": { "$ref": "#/components/schemas/PreAuthorisationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group Example (AIS) Response": { "$ref": "#/components/examples/berlin-group-example-ais-pre-auth-response" }, "Berlin Group Example (PIS) Response": { "$ref": "#/components/examples/berlin-group-pis-pre-auth-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfPreAuthorisationResponse" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Pre-authorisation", "tags": [ "Authorisations" ] } }, "/payment-pre-auth-requests": { "x-yapily-features": [ "INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS" ], "post": { "description": "Used to initiate the pre-authorisation process for payments for CBI Globe institutions that contain the `INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS` feature to authenticate the user.

Feature: `INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS`", "operationId": "createPaymentPreAuthorisationRequest", "parameters": [ { "description": "__Optional__. Used to obtain the raw request and response to and from the Institution.", "in": "query", "name": "raw", "required": false, "schema": { "type": "boolean" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "CBI Globe (PIS) example request": { "$ref": "#/components/examples/cbi-globe-pis-pre-auth-example-request" } }, "schema": { "$ref": "#/components/schemas/PaymentPreAuthorisationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Berlin Group Example (PIS) Response": { "$ref": "#/components/examples/berlin-group-pis-pre-auth-example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfPreAuthorisationResponse" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Payment Pre-authorisation", "tags": [ "Authorisations" ] } }, "/users": { "get": { "description": "Retrieves all users created in your application for a specified applicationUserId using the filter[applicationUserId] query parameter. If filter[applicationUserId] is not provided, the response will include up to 50,000 users.", "operationId": "getUsers", "parameters": [ { "description": "__Optional__. Filter records based on the list of `applicationUserId` users provided.", "in": "query", "name": "filter[applicationUserId]", "required": false, "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/users_example-response" } }, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationUser" } } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Users", "tags": [ "Users" ] }, "post": { "description": "Create a new user in your application", "operationId": "addUser", "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Create User Example Request": { "$ref": "#/components/examples/create-user-example-request" } }, "schema": { "$ref": "#/components/schemas/NewApplicationUser" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/create-user_example-response" } }, "schema": { "$ref": "#/components/schemas/ApplicationUser" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create User", "tags": [ "Users" ] } }, "/users/{userUuid}": { "patch": { "description": "Update the users information", "operationId": "patchUser", "parameters": [ { "description": "__Mandatory__. The Yapily generated UUID for the user.", "in": "path", "name": "userUuid", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationUserPatchRequest" } } } } }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApplicationUser" } } }, "description": "Created" }, "default": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Update User", "tags": [ "Users" ] }, "delete": { "description": "Delete a user from your application along with any sub-resources (including consent resources on institution APIs if they exist)", "operationId": "deleteUser", "parameters": [ { "description": "__Mandatory__. The Yapily generated UUID for the user.", "in": "path", "name": "userUuid", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/delete-user_example-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfUserDeleteResponse" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Delete User", "tags": [ "Users" ] }, "get": { "description": "Get a specific user using the user UUID", "operationId": "getUser", "parameters": [ { "description": "__Mandatory__. The Yapily generated UUID for the user.", "in": "path", "name": "userUuid", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "$ref": "#/components/examples/user_example-response" } }, "schema": { "$ref": "#/components/schemas/ApplicationUser" } } }, "description": "Ok" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get User", "tags": [ "Users" ] } }, "/notifications/event-subscriptions": { "post": { "tags": [ "Notifications" ], "summary": "Create Event Subscription", "description": "Used to subscribe to notifications relating to a specified event type.", "operationId": "createEventSubscription", "x-beta": true, "parameters": [ { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSubscriptionRequest" } } } }, "responses": { "201": { "description": "Event subscription created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseOfEventSubscriptionResponse" } } } }, "400": { "description": "Bad request for missing required properties" }, "401": { "description": "Unauthorized" }, "409": { "description": "Event subscription already exist for the application" } } }, "get": { "tags": [ "Notifications" ], "summary": "Get Event Subscriptions", "description": "Get all event subscriptions that your application is subscribed to", "operationId": "getEventSubscriptions", "x-beta": true, "parameters": [ { "description": "The sub-application ID for which all event subscriptions will be returned", "in": "header", "name": "sub-application", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Event subscriptions for the application", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiListResponseOfEventSubscriptionResponse" } } } }, "401": { "description": "Unauthorized" } } } }, "/notifications/event-subscriptions/{eventTypeId}": { "get": { "tags": [ "Notifications" ], "summary": "Get Event Subscription", "description": "Used to get details of your subscription to a specified event type.", "operationId": "getEventSubscriptionById", "x-beta": true, "parameters": [ { "$ref": "#/components/parameters/EventTypeId" }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "description": "Event subscription data found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseOfEventSubscriptionResponse" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Event subscription not found" } } }, "delete": { "tags": [ "Notifications" ], "summary": "Delete Event Subscription", "description": "Used to unsubscribe to notifications relating to a specified event type.", "operationId": "deleteEventSubscriptionById", "x-beta": true, "parameters": [ { "$ref": "#/components/parameters/EventTypeId" }, { "description": "The sub-application ID for which event type will be deleted", "in": "header", "name": "sub-application", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Event subscription deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponseOfEventSubscriptionDeleteResponse" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Event subscription not found" } } } }, "/variable-recurring-payments/sweeping/consents": { "x-yapily-features": [ "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING" ], "post": { "description": "Initiate authorisation for a Sweeping [VRP](https://docs.yapily.com/payments/vrps/introduction) consent.

The response will contain an Authorisation URL and the associated Consent ID. The user will have to complete authorisation of the consent at their institution via [Redirect Flows](https://docs.yapily.com/getting-started/glossary#redirect-flow), after which you will be able to use the authorised consent to create payments.

Required feature: `INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING`", "operationId": "createSweepingAuthorisation", "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "UK Sweeping VRP Authorisation Request": { "description": "UK Sweeping VRP Authorisation Request", "value": { "userUuid": "00000000-0000-0000-0000-000000000000", "institutionId": "modelo-sandbox", "callback": "https://display-parameters.com/", "controlParameters": { "psuAuthenticationMethods": [ "SCA_NOT_REQUIRED" ], "maxAmountPerPayment": { "amount": 10, "currency": "GBP" }, "periodicLimits": [ { "totalMaxAmount": { "amount": 50, "currency": "GBP" }, "frequency": "MONTHLY", "alignment": "CONSENT" } ] }, "initiationDetails": { "reference": "My Sweeping VRP", "payer": { "name": "My Name (From)", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "87654321" }, { "type": "SORT_CODE", "identification": "332211" } ] }, "payee": { "name": "My Name (To)", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "12345678" }, { "type": "SORT_CODE", "identification": "112233" } ] } } } } }, "schema": { "$ref": "#/components/schemas/VrpSweepingAuthorisationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json;charset=UTF-8": { "examples": { "UK Sweeping VRP Authorisation Response": { "description": "UK Sweeping VRP Authorisation Response", "value": { "meta": { "tracingId": "96169af01d394ad39658f17d53b49a5d" }, "data": { "id": "a2a9ec77-a479-4996-9896-4568e1968e7a", "userUuid": "00000000-0000-0000-0000-000000000000", "applicationUserId": "user000", "institutionId": "modelo-sandbox", "status": "AWAITING_AUTHORIZATION", "createdAt": "2026-01-01T10:25:13Z", "featureScope": [ "EXISTING_PAYMENTS_DETAILS", "EXISTING_PAYMENT_INITIATION_DETAILS", "CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING", "VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION", "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING" ], "state": "80052c03007f41d589f64377eef4d620", "institutionConsentId": "sdp-6-25ff5bd8-d01c-422d-aa9e-8e68808bc899", "authorisationUrl": "https://ob19-auth1-ui.o3bank.co.uk/auth?client_id=e7f6b95b-5f35-419b-b301-8b08bcd946de&response_type=code+id_token&state=80052c03007f41d589f64377eef4d620&nonce=80052c03007f41d589f64377eef4d620&scope=openid+payments&redirect_uri=https%3A%2F%2Fauth.yapily.com%2F&request=eyJraWQiOiJnRTRvU3VaZDl4TVpUNXZDdTNWYy1mdktNak0iLCJhbGciOiJQUzI1NiJ9.eyJhdWQiOiJodHRwczovL29iMTktYXV0aDEtdWkubzNiYW5rLmNvLnVrIiwic2NvcGUiOiJvcGVuaWQgcGF5bWVudHMiLCJpc3MiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJjbGllbnRfaWQiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJyZXNwb25zZV90eXBlIjoiY29kZSBpZF90b2tlbiIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOi8vYXV0aC55YXBpbHkuY29tLyIsInN0YXRlIjoiODAwNTJjMDMwMDdmNDFkNTg5ZjY0Mzc3ZWVmNGQ2MjAiLCJjbGFpbXMiOnsiaWRfdG9rZW4iOnsiYWNyIjp7InZhbHVlIjoidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoic2RwLTYtMjVmZjViZDgtZDAxYy00MjJkLWFhOWUtOGU2ODgwOGJjODk5IiwiZXNzZW50aWFsIjp0cnVlfX0sInVzZXJpbmZvIjp7Im9wZW5iYW5raW5nX2ludGVudF9pZCI6eyJ2YWx1ZSI6InNkcC02LTI1ZmY1YmQ4LWQwMWMtNDIyZC1hYTllLThlNjg4MDhiYzg5OSIsImVzc2VudGlhbCI6dHJ1ZX19fSwibm9uY2UiOiI4MDA1MmMwMzAwN2Y0MWQ1ODlmNjQzNzdlZWY0ZDYyMCIsImp0aSI6ImUxYjZmMWM4LTQ1ZTktNGM0NS05NGE0LWExMTY1Nzk2NjZiNiIsImlhdCI6MTYyMzI0NjUwNSwiZXhwIjoxNjIzMjQ4MzA1fQ.C5YkClHiDOWl1CKnmEY0gM_JizUuELp2-k7sDjsWV5T-mgTWviO-jM7iVfCf4MsU6batLSBmeUFLco1b3S8PTQkAzwM3laHIgbfDAb_6bYkSBTbPriyzKcC8xAwhX3VdvWtb9qqdrn9zXSmIIITBhJdMzk1cgIjyETD7WNPln839eGP1-w8iB8yDOJOkYGRHJ850mQY-lk61GegmKs5kaxtYPIhrG2gygIi3JsN-uQJ6YOl2-5pylTEcJbuwhFiyeePdqHZdabqW2BSA6lDKQbMV_Zow_zhSWoFFv6RZdXCQpt4TBRj1W7tzZQKin-MC-TpzaF1q07RpSy0NtlN85w", "qrCodeUrl": "https://images.yapily.com/image/2bbb79b8-2c4a-4c8e-9132-0636879437da/1623246505?size=0", "controlParameters": { "psuAuthenticationMethods": [ "SCA_NOT_REQUIRED" ], "maxAmountPerPayment": { "amount": 10, "currency": "GBP" }, "periodicLimits": [ { "totalMaxAmount": { "amount": 50, "currency": "GBP" }, "frequency": "MONTHLY", "alignment": "CONSENT" } ] }, "initiationDetails": { "reference": "My Sweeping VRP", "payer": { "name": "My Name (From)", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "87654321" }, { "type": "SORT_CODE", "identification": "332211" } ] }, "payee": { "name": "My Name (To)", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "12345678" }, { "type": "SORT_CODE", "identification": "112233" } ] } } } } } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfVrpSweepingAuthorisationResponse" } } } }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 401, "status": "UNAUTHORIZED", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "CREDENTIALS", "code": "CREDENTIALS_MISSING", "message": "Authentication header not present" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 400, "status": "BAD_REQUEST", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "BAD_REQUEST", "code": "BAD_REQUEST", "message": "The server could not understand the request due to invalid syntax" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response" } }, "summary": "Create Sweeping VRP Authorisation", "tags": [ "Variable Recurring Payments" ] } }, "/variable-recurring-payments/sweeping/consents/{consentId}": { "get": { "description": "Get Sweeping [VRP](https://docs.yapily.com/payments/vrps/introduction) consent details from the Consent ID.

Required feature: `CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING`", "operationId": "getSweepingVrpConsentById", "parameters": [ { "description": "The Consent ID to retrieve.", "in": "path", "name": "consentId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;charset=UTF-8": { "examples": { "UK Sweeping VRP Consent Details Response": { "description": "Get Sweeping Variable Recurring Payments Consent Example Response", "value": { "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": [ "EXISTING_PAYMENTS_DETAILS", "EXISTING_PAYMENT_INITIATION_DETAILS", "CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING", "VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION", "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING" ], "consentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg", "state": "a09f8ff9c1284444aa635267e05f76e1", "authorizedAt": "2021-06-08T10:59:53.288Z", "institutionConsentId": "aac-605d48f2-2a0e-4594-81a9-996524fa3b2a", "controlParameters": { "psuAuthenticationMethods": [ "SCA_NOT_REQUIRED" ], "periodicLimits": [ { "totalMaxAmount": { "amount": 100, "currency": "GBP" }, "frequency": "DAILY", "alignment": "CONSENT" } ], "maxAmountPerPayment": { "amount": 10, "currency": "GBP" } }, "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "87654321" }, { "type": "SORT_CODE", "identification": "654321" } ] }, "initiationDetails": { "reference": "Own Account Sweeping", "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "87654321" }, { "type": "SORT_CODE", "identification": "654321" } ] }, "payee": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "12345678" }, { "type": "SORT_CODE", "identification": "123456" } ] } } } } } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfVrpSweepingAuthorisationResponse" } } } }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 401, "status": "UNAUTHORIZED", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "CREDENTIALS", "code": "CREDENTIALS_MISSING", "message": "Authentication header not present" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 400, "status": "BAD_REQUEST", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "BAD_REQUEST", "code": "BAD_REQUEST", "message": "The server could not understand the request due to invalid syntax" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response" } }, "summary": "Get Sweeping VRP Consent Details", "tags": [ "Variable Recurring Payments" ] } }, "/variable-recurring-payments/funds-confirmation": { "x-yapily-features": [ "VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION" ], "post": { "description": "Check whether the requested funds amount is available on the [VRP](https://docs.yapily.com/payments/vrps/introduction) consent.

Note that you should not call this before each VRP payment submission because we do it for you.

Required feature: `VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION`", "operationId": "createVrpFundsConfirmation", "parameters": [ { "description": "The user's VRP [Consent Token](https://docs.yapily.com/getting-started/glossary#consent-token)", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "UK VRP Funds Confirmation Request": { "description": "UK VRP Funds Confirmation Request", "value": { "reference": "Own Account Sweeping", "paymentAmount": { "amount": 10, "currency": "GBP" } } } }, "schema": { "$ref": "#/components/schemas/VrpFundsConfirmationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json;charset=UTF-8": { "examples": { "UK VRP Funds Confirmation Response": { "description": "UK VRP Funds Confirmation Response", "value": { "meta": { "tracingId": "0f14e900011b445fa6b6c2c4272d7321" }, "data": { "id": "a9582f8e-08be-4cca-9f01-1ad3be96532d", "fundsAvailable": { "fundsAvailable": true, "fundsAvailableAt": "2021-06-08T10:59:35.138Z" }, "reference": "Own Account Sweeping", "paymentAmount": { "amount": 10, "currency": "GBP" } } } } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfVrpFundsConfirmationResponse" } } } }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 401, "status": "UNAUTHORIZED", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "CREDENTIALS", "code": "CREDENTIALS_MISSING", "message": "Authentication header not present" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 400, "status": "BAD_REQUEST", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "BAD_REQUEST", "code": "BAD_REQUEST", "message": "The server could not understand the request due to invalid syntax" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response" } }, "summary": "Confirm Funds for VRP Payment", "tags": [ "Variable Recurring Payments" ] } }, "/variable-recurring-payments/payments": { "x-yapily-features": [ "CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING" ], "post": { "description": "Submit payment on the [VRP](https://docs.yapily.com/payments/vrps/introduction) consent.

Required feature: `CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING` or `CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL`", "operationId": "createVrpPayment", "parameters": [ { "description": "The user's VRP [Consent Token](https://docs.yapily.com/getting-started/glossary#consent-token)", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "UK VRP Payment Request": { "description": "UK VRP Payment Request", "value": { "paymentIdempotencyId": "234g87t58tgeuo848wudjew489", "psuAuthenticationMethod": "SCA_NOT_REQUIRED", "paymentAmount": { "amount": 10, "currency": "GBP" } } } }, "schema": { "$ref": "#/components/schemas/VrpSubmissionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json;charset=UTF-8": { "examples": { "UK VRP Payment Response": { "description": "UK VRP Payment Response", "value": { "meta": { "tracingId": "0f14e900011b445fa6b6c2c4272d7321" }, "data": { "id": "a9582f8e-08be-4cca-9f01-1ad3be96532d", "paymentIdempotencyId": "234g87t58tgeuo848wudjew489", "institutionConsentId": "PF23232222DD", "status": "COMPLETED", "statusDetails": { "status": "COMPLETED", "isoStatus": { "code": "ACCP", "name": "AcceptedCustomerProfile" } }, "initiationDetails": { "reference": "Own Account Sweeping", "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "87654321" }, { "type": "SORT_CODE", "identification": "654321" } ] }, "payee": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "12345678" }, { "type": "SORT_CODE", "identification": "123456" } ] } }, "submissionDetails": { "reference": "Own Account Sweeping", "payee": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "12345678" }, { "type": "SORT_CODE", "identification": "123456" } ] }, "paymentAmount": { "amount": 10, "currency": "GBP" } }, "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "87654321" }, { "type": "SORT_CODE", "identification": "654321" } ] }, "refundAccount": { "accountIdentifications": [ { "identification": "400400", "type": "SORT_CODE" }, { "identification": "99999999", "type": "ACCOUNT_NUMBER" } ], "name": "Refund Account" }, "expectedSettlementTime": "2022-03-02T12:00:00.000Z", "expectedExecutionTime": "2022-03-02T12:00:00.000Z" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfVrpSubmissionResponse" } } } }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 401, "status": "UNAUTHORIZED", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "CREDENTIALS", "code": "CREDENTIALS_MISSING", "message": "Authentication header not present" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 400, "status": "BAD_REQUEST", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "BAD_REQUEST", "code": "BAD_REQUEST", "message": "The server could not understand the request due to invalid syntax" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response" } }, "summary": "Create VRP Payment", "tags": [ "Variable Recurring Payments" ] } }, "/variable-recurring-payments/payments/{paymentId}/details": { "get": { "description": "Get [VRP](https://docs.yapily.com/payments/vrps/introduction) payment details from the Payment ID.

Required feature: `CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING` or `CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL`", "operationId": "getVrpPaymentDetails", "parameters": [ { "description": "The Payment ID to retrieve.", "in": "path", "name": "paymentId", "required": true, "schema": { "type": "string" } }, { "description": "The user's VRP [Consent Token](https://docs.yapily.com/getting-started/glossary#consent-token)", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json;charset=UTF-8": { "examples": { "UK VRP Payment Details Response": { "description": "UK VRP Payment Details Response", "value": { "meta": { "tracingId": "679e7bb6cd45416a9a9a8d004c5315da" }, "data": { "id": "a9582f8e-08be-4cca-9f01-1ad3be96532d", "paymentIdempotencyId": "234g87t58tgeuo848wudjew489", "institutionConsentId": "PF23232222DD", "status": "COMPLETED", "statusDetails": { "status": "COMPLETED", "isoStatus": { "code": "ACCP", "name": "AcceptedCustomerProfile" } }, "initiationDetails": { "reference": "Own Account Sweeping", "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "87654321" }, { "type": "SORT_CODE", "identification": "654321" } ] }, "payee": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "12345678" }, { "type": "SORT_CODE", "identification": "123456" } ] } }, "submissionDetails": { "reference": "Own Account Sweeping", "payee": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "12345678" }, { "type": "SORT_CODE", "identification": "123456" } ] }, "paymentAmount": { "amount": 10, "currency": "GBP" } }, "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "87654321" }, { "type": "SORT_CODE", "identification": "654321" } ] }, "refundAccount": { "accountIdentifications": [ { "identification": "400400", "type": "SORT_CODE" }, { "identification": "99999999", "type": "ACCOUNT_NUMBER" } ], "name": "Refund Account" }, "expectedSettlementTime": "2022-03-02T12:00:00.000Z", "expectedExecutionTime": "2022-03-02T12:00:00.000Z" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfVrpSubmissionResponse" } } } }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 401, "status": "UNAUTHORIZED", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "CREDENTIALS", "code": "CREDENTIALS_MISSING", "message": "Authentication header not present" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 400, "status": "BAD_REQUEST", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "BAD_REQUEST", "code": "BAD_REQUEST", "message": "The server could not understand the request due to invalid syntax" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } }, "description": "Error Response" } }, "summary": "Get VRP Payment Details", "tags": [ "Variable Recurring Payments" ] } }, "/accounts/{accountId}/real-time/transactions": { "get": { "description": "Used to get the account transactions for an account in real time with cursor pagination

Feature: `ACCOUNT_TRANSACTIONS`", "operationId": "getRealTimeTransactions", "x-beta": true, "parameters": [ { "description": "__Mandatory__. The account Id of the user's bank account.", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/knowledge/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/knowledge/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/knowledge/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" }, { "description": "__Optional__. Returned transactions will be on or after this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).", "in": "query", "name": "from", "required": false, "schema": { "type": "string" } }, { "description": "__Optional__. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ).", "in": "query", "name": "before", "required": false, "schema": { "type": "string" } }, { "description": "__Optional__. The cursor token supplied by a previous call. The cursor represents a location in the data set.", "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Example Response": { "description": "Example Response", "value": { "meta": { "tracingId": "488ce8243ee74a378be722ffffec8f7f", "count": 1 }, "data": [ { "id": "49d6e5c6-0130-46e3-884b-1b185432d9e0", "date": "2021-05-06T17:44:34.589Z", "bookingDateTime": "2021-05-06T17:44:34.589Z", "valueDateTime": "2021-05-06T17:44:34.589Z", "status": "BOOKED", "transactionAmount": { "amount": -100.23, "currency": "GBP" }, "reference": "0", "description": "Debit for Payment Id: sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60", "transactionInformation": [ "Debit for Payment Id: sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60" ], "isoBankTransactionCode": { "domainCode": { "code": "PMNT", "name": "Payments" }, "familyCode": { "code": "ICDT", "name": "Issued Credit Transfers" }, "subFamilyCode": { "code": "DMCT", "name": "Domestic Credit Transfer" } }, "proprietaryBankTransactionCode": { "code": "PMT", "issuer": "modelo-sandbox" }, "balance": { "type": "CLOSING_AVAILABLE", "balanceAmount": { "amount": 426.53, "currency": "GBP" } } } ], "links": { "first": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=aaa", "prev": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=bbb", "self": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=ccc", "next": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=ddd", "last": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=zzz" } } } }, "schema": { "$ref": "#/components/schemas/ApiListResponseOfRealTimeTransaction" } } }, "description": "Ok" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 401, "status": "UNAUTHORIZED", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "CREDENTIALS", "code": "CREDENTIALS_MISSING", "message": "Authentication header not present" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "description": "Error Response", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 400, "status": "BAD_REQUEST", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "BAD_REQUEST", "code": "BAD_REQUEST", "message": "The server could not understand the request due to invalid syntax" } ] } } } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Real Time Account Transactions", "tags": [ "Financial Data" ] } }, "/accounts/{accountId}/transactions/categorisation": { "parameters": [ { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a personal account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. Represents the user's login ID for the `Institution` to a business account.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-corporate-id", "required": false, "schema": { "type": "string" } }, { "description": "__Conditional__. The IP address of the PSU.

See [PSU identifiers](https://docs.yapily.com/pages/knowledge/open-banking/psu_identifiers/) to see if this header is required.", "in": "header", "name": "psu-ip-address", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" }, { "schema": { "type": "string" }, "name": "accountId", "in": "path", "required": true, "description": "Unique identifier for account" } ], "post": { "operationId": "post-accounts-accountId-transactions-categorisation", "summary": "Transactions and Enrichment", "description": "Trigger categorisation for transactions from [AIS (see Get Transactions endpoint)](https://docs.yapily.com/api/reference/#operation/getTransactions) in the specified time range.", "tags": [ "Data Plus" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "categorisationType", "countryCode" ], "properties": { "countryCode": { "type": "string", "description": "__Mandatory__. Two-letter country code in ISO 3166-1 alpha-2 format (e.g. GB)" }, "categorisationType": { "type": "string", "description": "__Mandatory__. Allowed values are `consumer` and `business`." }, "from": { "type": "string", "format": "date-time", "description": "__Optional__. Returned transactions will be on or after this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ). " }, "before": { "type": "string", "format": "date-time", "description": "__Optional__. Returned transactions will be on or before this date (yyyy-MM-dd'T'HH:mm:ss.SSSZ)." } } }, "examples": { "Example": { "value": { "countryCode": "GB", "categorisationType": "consumer", "from": "2019-08-24T14:15:22Z", "before": "2019-08-24T14:15:22Z" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseOfCreateTransactionsCategorisationRequest" }, "examples": { "Example 1": { "$ref": "#/components/examples/create-transactions-categorisation-response" } } } } }, "400": { "description": "Validation Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "500": { "description": "Unexpected Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } } } }, "/accounts/{accountId}/transactions/categorisation/{categorisationId}": { "parameters": [ { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent", "required": true, "schema": { "type": "string" } }, { "schema": { "type": "string" }, "name": "accountId", "in": "path", "required": true, "description": "Unique identifier for account" }, { "schema": { "type": "string" }, "name": "categorisationId", "in": "path", "required": true, "description": "Unique identifier for transaction categorisation request" }, { "$ref": "#/components/parameters/SubAppHeader" }, { "description": "__Optional__. The maximum number of transaction records to be returned. Must be between 100 and 1000. If not specified will default to 100.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 100, "maximum": 1000 } }, { "description": "__Optional__. The page number to be returned. If not specified will default to 1.", "in": "query", "name": "page", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1 } } ], "get": { "deprecated": true, "operationId": "get-accounts-transactions-categorised", "summary": "Get Categorised Transactions (Deprecated)", "description": "__Deprecated__. Retrieve categorised transactions by Categorisation ID.

Use the [other endpoint (`/transactions/categorisation/{categorisationId}`)](#operation/get-transactions-categorised) instead.", "tags": [ "Data Plus" ], "responses": { "200": { "description": "OK", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseOfGetCategorisedTransactionsRequest" }, "examples": { "Example 1": { "$ref": "#/components/examples/get-categorised-transactions-response" } } } } }, "400": { "description": "Validation Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "404": { "description": "Categorisation ID not found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/404-error-response" } } } } }, "500": { "description": "Unexpected Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } } } }, "/transactions/categorisation": { "parameters": [ { "$ref": "#/components/parameters/SubAppHeader" } ], "post": { "operationId": "post-transactions-categorisation", "summary": "Enrichment", "description": "Trigger categorisation for transactions provided in the request.", "tags": [ "Data Plus" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "categorisationType", "countryCode", "transactions" ], "properties": { "countryCode": { "type": "string", "description": "__Mandatory__. Two-letter country code in ISO 3166-1 alpha-2 format (e.g. GB)" }, "categorisationType": { "type": "string", "description": "__Mandatory__. Allowed values are `consumer` and `business`." }, "transactions": { "type": "array", "items": { "type": "object", "required": [ "id", "date", "amount", "description", "countryCode" ], "properties": { "id": { "type": "string", "description": "__Mandatory__. A globally unique transaction ID." }, "date": { "type": "string", "description": "__Mandatory__. Transaction date in ISO 8601 format (eg. 2025-01-01T12:59:59.999Z)" }, "amount": { "type": "object", "required": [ "value", "currency" ], "properties": { "value": { "type": "integer", "description": "__Mandatory__. Transaction money amount in cents (or equivalent). Positive amount implies money in, negative amount implies money out." }, "currency": { "type": "string", "description": "__Mandatory__. Transaction currency." } } }, "merchant": { "type": "object", "properties": { "mcc": { "type": "string", "description": "__Optional__. Merchant Category Code (MCC) according to ISO 18245" } } }, "description": { "type": "string", "description": "__Mandatory__. Transaction-specific description." }, "countryCode": { "type": "string", "description": "__Mandatory__. Transaction-specific two-letter country code in ISO 3166-1 alpha-2 format (e.g. GB)" } } } } } }, "examples": { "Example 1": { "value": { "countryCode": "GB", "categorisationType": "consumer", "transactions": [ { "id": "06edf952-8d94-44ae-8d4e-a065b7e47300", "date": "2025-03-01T14:15:16Z", "amount": { "value": -9900, "currency": "GBP" }, "description": "Shopping", "countryCode": "GB" }, { "id": "6a241cae-7c43-4058-bdbd-ff9d64e6c9df", "date": "2025-04-02T07:59:59Z", "amount": { "value": 1000, "currency": "USD" }, "description": "Refund", "countryCode": "GB" } ] } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseOfCreateTransactionsCategorisationRequest" }, "examples": { "Example 1": { "$ref": "#/components/examples/create-transactions-categorisation-response" } } } } }, "400": { "description": "Validation Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "500": { "description": "Unexpected Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } } } }, "/transactions/categorisation/{categorisationId}": { "parameters": [ { "schema": { "type": "string" }, "name": "categorisationId", "in": "path", "required": true, "description": "Unique identifier for transaction categorisation request" }, { "$ref": "#/components/parameters/SubAppHeader" }, { "description": "__Optional__. The maximum number of transaction records to be returned. Must be between 100 and 1000. If not specified will default to 100.", "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 100, "maximum": 1000 } }, { "description": "__Optional__. The page number to be returned. If not specified will default to 1.", "in": "query", "name": "page", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1 } } ], "get": { "operationId": "get-transactions-categorised", "summary": "Get Enrichment Results", "description": "Retrieve categorised transactions by Categorisation ID.

Please [use webhooks](https://docs.yapily.com/pages/data/data-plus/tutorial-categorisation/) to be notified when your transactions have been categorised and are ready for retrieval.

Note that when using the [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation) this endpoint may also return any data specified by the [Get Account Transactions endpoint](https://docs.yapily.com/api/reference/#operation/getTransactions); this endpoint's docs mentions a non-exhaustive subset of such data.", "tags": [ "Data Plus" ], "responses": { "200": { "description": "OK", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseOfGetCategorisedTransactionsRequest" }, "examples": { "Example 1": { "$ref": "#/components/examples/get-categorised-transactions-response" } } } } }, "400": { "description": "Validation Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "404": { "description": "Categorisation ID not found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/404-error-response" } } } } }, "500": { "description": "Unexpected Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } } } }, "/transactions/categorisation/categories/{accountType}": { "parameters": [ { "schema": { "type": "string" }, "name": "accountType", "in": "path", "required": true, "description": "type of bank account (consumer or business)" }, { "$ref": "#/components/parameters/SubAppHeader" } ], "get": { "operationId": "get-categorisation-accountType", "summary": "Get Enrichment Labels", "description": "Returns the list of categories that can be returned for a specific account type (consumer or business).", "tags": [ "Data Plus" ], "responses": { "200": { "description": "OK", "content": { "application/json;charset=UTF-8": { "schema": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "tracingId": { "type": "string" } } }, "data": { "$ref": "#/components/schemas/GetCategoriesResponse" } } }, "examples": { "Example consumer": { "value": { "meta": { "tracingId": "string" }, "data": { "labels": [ "ATM/bank deposit", "Benefits", "ATM/bank withdrawal", "App stores" ] } } }, "Example business": { "value": { "meta": { "tracingId": "string" }, "data": { "labels": [ "client deposit", "cost of goods sold - customer return" ] } } } } } } }, "400": { "description": "Validation Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "404": { "description": "Account type not found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/404-error-response" } } } } }, "500": { "description": "Unexpected Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } } } }, "/hosted/consent-requests": { "post": { "description": "Used to initiate a consent request using Yapily Hosted Pages.", "x-beta": true, "operationId": "createHostedConsentRequest", "parameters": [ { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Create Hosted Consent Request": { "$ref": "#/components/examples/create-hosted-consent-request" } }, "schema": { "$ref": "#/components/schemas/CreateHostedConsentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Create Hosted Consent Request Response": { "$ref": "#/components/examples/create-hosted-consent-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfCreateHostedConsentRequest" } } }, "description": "Created" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "400 Error Response": { "$ref": "#/components/examples/400-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unauthorized. Credentials are missing or invalid" }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Hosted Consent Request", "tags": [ "Hosted Consent Pages" ] } }, "/hosted/consent-requests/{consentRequestId}": { "get": { "description": "Used to get details of a hosted consent request", "x-beta": true, "operationId": "getHostedConsentRequest", "parameters": [ { "description": "Unique Identifier of the consent request", "in": "path", "name": "consentRequestId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Get Hosted Consent Request Response": { "$ref": "#/components/examples/get-hosted-consent-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfGetHostedConsentRequest" } } }, "description": "Ok" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json;charset=UTF-8": { "examples": { "404 Error Response": { "$ref": "#/components/examples/404-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Not Found" }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Hosted Consent Request", "tags": [ "Hosted Consent Pages" ] } }, "/hosted/payment-requests": { "x-yapily-features": [ "INITIATE_DOMESTIC_SINGLE_PAYMENT" ], "post": { "description": "Used to initiate a payment request using Yapily Hosted Pages.", "x-beta": true, "operationId": "createHostedPaymentRequest", "parameters": [ { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Create Hosted Payment Request": { "$ref": "#/components/examples/create-hosted-payment-request" } }, "schema": { "$ref": "#/components/schemas/CreateHostedPaymentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Create Hosted Payment Request Response": { "$ref": "#/components/examples/create-hosted-payment-request-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfCreateHostedPaymentRequest" } } }, "description": "Created" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "400 Error Response": { "$ref": "#/components/examples/400-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unauthorized. Credentials are missing or invalid" }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Hosted payment request", "tags": [ "Hosted Payment Pages" ] } }, "/hosted/payment-requests/links": { "post": { "description": "Used to created a long lived payment request for Pay By Link", "x-beta": true, "operationId": "createHostedPaymentRequestLink", "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Create Hosted Payment Request": { "$ref": "#/components/examples/create-hosted-payment-request-link" } }, "schema": { "$ref": "#/components/schemas/CreateHostedPaymentRequestLink" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Create Hosted Payment Request Response": { "$ref": "#/components/examples/create-hosted-payment-request-link-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfCreateHostedPaymentRequestLink" } } }, "description": "Created" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "400 Error Response": { "$ref": "#/components/examples/400-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unauthorized. Credentials are missing or invalid" }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create Pay By Link", "tags": [ "Hosted Payment Pages" ] } }, "/hosted/payment-requests/{paymentRequestId}": { "get": { "description": "Used to get details of a payment request", "x-beta": true, "operationId": "getHostedPaymentRequest", "parameters": [ { "description": "Unique Identifier of the payment request", "in": "path", "name": "paymentRequestId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Get Hosted Payment Request Response": { "$ref": "#/components/examples/get-hosted-payment-request-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfGetHostedPaymentRequest" } } }, "description": "Ok" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json;charset=UTF-8": { "examples": { "404 Error Response": { "$ref": "#/components/examples/404-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Not Found" }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Get Hosted payment request", "tags": [ "Hosted Payment Pages" ] } }, "/hosted/vrp/consent-requests": { "post": { "description": "Used to initiate a VRP consent / mandate request through Yapily Hosted Pages", "operationId": "createHostedVRPConsentRequest", "x-beta": true, "parameters": [ { "description": "__Mandatory__. The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)", "in": "header", "name": "sub-application", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/CreateHostedVRPConsentRequest" }, "examples": { "Create Hosted VRP Consent Request": { "$ref": "#/components/examples/create-hosted-vrp-consent-request" } } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseOfCreateHostedVRPConsentRequest" }, "examples": { "Create Hosted VRP Consent Response": { "$ref": "#/components/examples/create-hosted-vrp-consent-response" } } } }, "description": "Created" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "400 Error Response": { "$ref": "#/components/examples/400-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unauthorized. Credentials are missing or invalid" }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" } }, "summary": "Create VRP Consent", "tags": [ "Hosted Payment Pages" ] }, "get": { "description": "Used to get all VRP consent requests initiated through Yapily Hosted Pages", "operationId": "getHostedVRPConsentRequests", "x-beta": true, "parameters": [ { "description": "__Mandatory__. The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)", "in": "header", "name": "sub-application", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseOfGetHostedVRPConsentsRequest" }, "examples": { "Get Hosted VRP Consents Response": { "$ref": "#/components/examples/get-hosted-vrp-consents-response" } } } }, "description": "Ok" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "400 Error Response": { "$ref": "#/components/examples/400-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Bad Request" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unauthorized. Credentials are missing or invalid" }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" } }, "summary": "Get Hosted VRP Consent Requests", "tags": [ "Hosted Payment Pages" ] } }, "/hosted/vrp/consent-requests/{consentRequestId}": { "get": { "description": "Used to get details of a VRP Consent Request", "operationId": "getHostedVrpConsentRequest", "x-beta": true, "parameters": [ { "description": "The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)", "in": "header", "name": "sub-application", "schema": { "type": "string" } }, { "description": "Unique Identifier of the Consent Request", "in": "path", "name": "consentRequestId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseOfGetHostedVRPConsentRequest" }, "examples": { "Get Hosted VRP Consent Response": { "$ref": "#/components/examples/get-hosted-vrp-consent-response" } } } }, "description": "Ok" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json;charset=UTF-8": { "examples": { "404 Error Response": { "$ref": "#/components/examples/404-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Not Found" }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" } }, "summary": "Get Hosted VRP Consent Request", "tags": [ "Hosted Payment Pages" ] } }, "/hosted/vrp/consent-requests/{consentRequestId}/revoke": { "post": { "description": "Revoke Hosted VRP Consent Request", "operationId": "revokeHostedConsentRequest", "x-beta": true, "parameters": [ { "description": "The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)", "in": "header", "name": "sub-application", "schema": { "type": "string" } }, { "description": "Unique Identifier of the Consent Request", "in": "path", "name": "consentRequestId", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseOfRevokeHostedVRPConsentRequest" }, "examples": { "Revoke Hosted VRP Consent Response": { "$ref": "#/components/examples/revoke-hosted-vrp-consent-response" } } } }, "description": "Ok" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json;charset=UTF-8": { "examples": { "404 Error Response": { "$ref": "#/components/examples/404-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Not Found" }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" } }, "summary": "Revoke Hosted VRP Consent Request", "tags": [ "Hosted Payment Pages" ] } }, "/hosted/vrp/consent-requests/{consentRequestId}/payments": { "post": { "description": "Creates a Variable Recurring Payment", "operationId": "createHostedVrpPayment", "x-beta": true, "parameters": [ { "description": "Unique Identifier of the Consent Request", "in": "path", "name": "consentRequestId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent-token", "required": true, "schema": { "type": "string" } }, { "description": "The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)", "in": "header", "name": "sub-application", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Hosted VRP Payment Request": { "$ref": "#/components/examples/create-hosted-vrp-payment-request" } }, "schema": { "$ref": "#/components/schemas/CreateHostedVRPPaymentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseOfCreateHostedVRPPaymentRequest" }, "examples": { "Hosted VRP Payment Response": { "$ref": "#/components/examples/create-hosted-vrp-payment-response" } } } }, "description": "Created" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "400 Error Response": { "$ref": "#/components/examples/400-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Create VRP Payment", "tags": [ "Hosted Payment Pages" ] } }, "/hosted/vrp/consent-requests/{consentRequestId}/payments/{paymentId}": { "get": { "description": "Used to get details of a VRP Payment", "operationId": "getHostedVRPPaymentRequest", "x-beta": true, "parameters": [ { "description": "Unique Identifier of the Consent Request", "in": "path", "name": "consentRequestId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "description": "Unique Identifier of the Consent Request", "in": "path", "name": "paymentId", "required": true, "schema": { "type": "string" } }, { "description": "The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)", "in": "header", "name": "sub-application", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseOfGetHostedVRPPaymentRequest" }, "examples": { "UK Domestic VRP Payment Example Response": { "$ref": "#/components/examples/get-hosted-vrp-payment-response" } } } }, "description": "Ok" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json;charset=UTF-8": { "examples": { "404 Error Response": { "$ref": "#/components/examples/404-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Not Found" }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" } }, "summary": "Get VRP payment", "tags": [ "Hosted Payment Pages" ] } }, "/hosted/vrp/consent-requests/{consentRequestId}/funds-confirmation": { "post": { "description": "Confirms whether there are available funds on the Payer account to execute a Variable Recurring Payment after obtaining the user's authorisation.

Features:", "operationId": "createHostedVrpFundsConfirmation", "x-beta": true, "parameters": [ { "description": "Unique Identifier of the Consent Request", "in": "path", "name": "consentRequestId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "description": "__Mandatory__. The `consent-token` containing the user's authorisation to make the request.", "example": "{consentToken}", "in": "header", "name": "consent-token", "required": true, "schema": { "type": "string" } }, { "description": "The unique identifier of the sub application the request is being submitted on behalf of (e.g. an underlying merchant)", "in": "header", "name": "sub-application", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "examples": { "Hosted VRP Payment Request": { "$ref": "#/components/examples/create-hosted-vrp-fund-confirmation" } }, "schema": { "$ref": "#/components/schemas/VrpFundsConfirmationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiResponseOfVrpFundsConfirmationResponse" }, "examples": { "Hosted VRP Payment Response": { "$ref": "#/components/examples/create-hosted-vrp-fund-confirmation-response" } } } }, "description": "Created" }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" }, "default": { "content": { "application/json;charset=UTF-8": { "examples": { "400 Error Response": { "$ref": "#/components/examples/400-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Error Response" } }, "summary": "Check Funds Availability", "tags": [ "Hosted Payment Pages" ] } }, "/institutions/constraints/payments": { "get": { "description": "Retrieve institution specific constraints for payment authorisation and submission requests", "operationId": "getPaymentConstraintsRulesByInstitution", "x-beta": true, "parameters": [ { "description": "Unique Id(s) of the `Institution`(s) to retrieve the Payment Constraints for. Multiple institutionIds need to be separated by `,`", "name": "institutionIds", "required": true, "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "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.", "in": "query", "name": "institutionCountryCode", "required": true, "schema": { "type": "string" } }, { "description": "Type of payment to retrieve payment constraints for", "in": "query", "name": "paymentType", "required": true, "schema": { "type": "string", "enum": [ "DOMESTIC_PAYMENT", "DOMESTIC_INSTANT_PAYMENT", "DOMESTIC_VARIABLE_RECURRING_PAYMENT", "DOMESTIC_SCHEDULED_PAYMENT", "DOMESTIC_PERIODIC_PAYMENT", "INTERNATIONAL_PAYMENT", "INTERNATIONAL_SCHEDULED_PAYMENT", "INTERNATIONAL_PERIODIC_PAYMENT" ] } }, { "description": "The path on the API that is associated with the operation for which constraints are to be retrieved", "in": "query", "name": "endpointPath", "required": false, "schema": { "type": "string" } }, { "description": "The HTTP method that is associated with the operation for which constraints are to be retrieved", "in": "query", "name": "endpointMethod", "required": false, "schema": { "type": "string", "enum": [ "POST", "PATCH", "PUT", "GET", "DELETE" ] } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiListResponseOfPaymentConstraints" } } }, "description": "Ok" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/400-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Bad Request." }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Either authentication credentials were not supplied, or they were invalid." }, "404": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/404-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Not Found." }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" } }, "summary": "Get Payment Constraints Rules", "tags": [ "Constraints" ] } }, "/institutions/constraints/data": { "get": { "description": "Get Data Constraints Rules against an Institution for Account Authorisation requests", "operationId": "getAccountConstraintsRulesByInstitution", "x-beta": true, "parameters": [ { "description": "Unique Id(s) of the `Institution`(s) to retrieve the Data Constraints for. Multiple institutionIds need to be separated by `,`", "name": "institutionIds", "required": true, "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "description": "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.", "in": "query", "name": "institutionCountryCode", "required": true, "schema": { "type": "string" } }, { "description": "The path on the API that is associated with the operation for which constraints are to be retrieved", "in": "query", "name": "endpointPath", "required": false, "schema": { "type": "string" } }, { "description": "The HTTP method that is associated with the operation for which constraints are to be retrieved", "in": "query", "name": "endpointMethod", "required": false, "schema": { "type": "string", "enum": [ "POST", "PATCH", "PUT", "GET", "DELETE" ] } } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiListResponseOfDataConstraints" } } }, "description": "Ok" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/400-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Bad Request." }, "401": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/401-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Either authentication credentials were not supplied, or they were invalid." }, "404": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/404-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Not Found." }, "500": { "content": { "application/json;charset=UTF-8": { "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseError" } } }, "description": "Unexpected Error" } }, "summary": "Get Data Constraints Rules", "tags": [ "Constraints" ] } }, "/applications": { "post": { "description": "Creates a sub-application under the given root application id provided in the authentication token. The sub-application can use the root's credentials to call the API", "summary": "Creates a sub-application for the root application id provided in the authentication token", "x-beta": true, "operationId": "createSubApplication", "requestBody": { "description": "The sub-application to create", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationRequest" }, "examples": { "Create Sub-application Request": { "$ref": "#/components/examples/application-request" } } } } }, "responses": { "201": { "content": { "application/json;charset=UTF-8": { "examples": { "Create Sub-application Response": { "$ref": "#/components/examples/application-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfApplicationResponse" } } }, "description": "Sub-application was successfully created" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/application-error-response-code-400" } }, "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }, "description": "There are validation errors" }, "401": { "description": "Either authentication credentials were not supplied, or they were invalid.", "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden from accessing the requested Application.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Application with given root id not found.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "tags": [ "Application Management" ] }, "get": { "description": "Retrieves sub-applications for the root application provided in the authentication token. If a sub-application is provided in the authentication token, it will return an empty list.", "summary": "Retrieve sub-applications for the root application provided in the authentication token.", "x-beta": true, "operationId": "searchApplications", "parameters": [ { "$ref": "#/components/parameters/SearchApplicationsParameters" } ], "responses": { "200": { "description": "The sub-applications that are returned as part of the search results.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiListOfApplicationResponse" }, "examples": { "Get Applications Response": { "$ref": "#/components/examples/application-responses" } } } } }, "400": { "description": "There are validation errors", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "401": { "description": "Either authentication credentials were not supplied, or they were invalid.", "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden from accessing the requested Application.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "tags": [ "Application Management" ] } }, "/applications/{applicationId}": { "get": { "description": "Retrieves an application by the id provided in the path", "x-beta": true, "operationId": "getApplicationById", "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The id of the application being fetched" } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Get Application By Id Response": { "$ref": "#/components/examples/application-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfApplicationResponse" } } }, "description": "Application was successfully fetched" }, "401": { "description": "Either authentication credentials were not supplied, or they were invalid.", "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden from accessing the requested Application.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Application with given id not found.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "tags": [ "Application Management" ], "summary": "Get application details" }, "put": { "description": "Updates the application properties for the application with the given ID in the path", "x-beta": true, "operationId": "updateApplication", "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The id of the application being updated" } ], "requestBody": { "description": "The application to update", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationRequest" }, "examples": { "Update Application Request": { "$ref": "#/components/examples/application-request" } } } } }, "responses": { "200": { "content": { "application/json;charset=UTF-8": { "examples": { "Update Application Response": { "$ref": "#/components/examples/application-response" } }, "schema": { "$ref": "#/components/schemas/ApiResponseOfApplicationResponse" } } }, "description": "Application was successfully updated" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/application-error-response-code-400" } }, "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }, "description": "There are validation errors" }, "401": { "description": "Either authentication credentials were not supplied, or they were invalid.", "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden from accessing the requested Application.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "tags": [ "Application Management" ], "summary": "Update an Application" }, "delete": { "description": "Deletes the application with the given ID in the path", "x-beta": true, "operationId": "deleteApplication", "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The id of the application being deleted" } ], "responses": { "204": { "description": "Application was successfully deleted" }, "401": { "description": "Either authentication credentials were not supplied, or they were invalid.", "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/error-response-code-401" } }, "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden from accessing the requested Application.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Application with given id not found.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } }, "tags": [ "Application Management" ], "summary": "Delete an application" } }, "/applications/{applicationId}/vrp": { "post": { "description": "Create application vrp configuration", "summary": "Create application VRP configuration by Application Id", "x-beta": true, "operationId": "createApplicationVRPConfigurationByApplicationId", "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The id of the application that vrp configuration being created for" } ], "requestBody": { "description": "The vrp configuration to create", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VrpConfiguration" } } } }, "responses": { "201": { "description": "Application vrp configuration was successfully created" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/application-error-response-code-400" } }, "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }, "description": "There are validation errors" }, "401": { "description": "Either authentication credentials were not supplied, or they were invalid.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } } } } }, "403": { "description": "Forbidden from accessing the requested Application.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "403 Error Response": { "$ref": "#/components/examples/403-error-response" } } } } }, "404": { "description": "VRP Configuration with given application id not found.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "404 Error Response": { "$ref": "#/components/examples/404-error-response" } } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } } } } } }, "tags": [ "Application Management" ] }, "put": { "description": "Update application vrp configuration", "summary": "Update application VRP configuration by Application Id", "x-beta": true, "operationId": "updateApplicationVRPConfigurationByApplicationId", "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The id of the application that vrp configuration being created for" } ], "requestBody": { "description": "The vrp configuration to create", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VrpConfiguration" } } } }, "responses": { "201": { "description": "Application vrp configuration was successfully updated" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/application-error-response-code-400" } }, "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }, "description": "There are validation errors" }, "401": { "description": "Either authentication credentials were not supplied, or they were invalid.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } } } } }, "403": { "description": "Forbidden from accessing the requested Application.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "403 Error Response": { "$ref": "#/components/examples/403-error-response" } } } } }, "404": { "description": "VRP Configuration with given application id not found.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "404 Error Response": { "$ref": "#/components/examples/404-error-response" } } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } } } } } }, "tags": [ "Application Management" ] }, "get": { "description": "Get application vrp configuration", "summary": "Get application VRP configuration by Application Id", "x-beta": true, "operationId": "getApplicationVRPConfigurationByApplicationId", "parameters": [ { "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The id of the application that vrp configuration being created for" } ], "responses": { "200": { "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/VrpConfiguration" } } }, "description": "Application vrp configuration was successfully fetched" }, "400": { "content": { "application/json;charset=UTF-8": { "examples": { "Error Response": { "$ref": "#/components/examples/application-error-response-code-400" } }, "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } }, "description": "There are validation errors" }, "401": { "description": "Either authentication credentials were not supplied, or they were invalid.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "401 Error Response": { "$ref": "#/components/examples/401-error-response" } } } } }, "403": { "description": "Forbidden from accessing the requested Application.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "403 Error Response": { "$ref": "#/components/examples/403-error-response" } } } } }, "404": { "description": "VRP Configuration with given application id not found.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "404 Error Response": { "$ref": "#/components/examples/404-error-response" } } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" }, "examples": { "500 Error Response": { "$ref": "#/components/examples/500-error-response" } } } } } }, "tags": [ "Application Management" ] } }, "/webhook/events/categories": { "get": { "tags": [ "Webhooks" ], "description": "Retrieve a comprehensive list of event categories that can be registered for webhook notifications in your application. These event categories can be used to subscribe a webhook to specific events, enabling your application to receive real-time notifications when these events occur.", "summary": "Get Webhook Categories", "operationId": "getWebhookEventsCategories", "responses": { "200": { "description": "Event Categories", "content": { "application/json;charset=UTF-8": { "examples": { "SuccessfulResponse": { "value": { "metadata": { "tracingId": "f2425b79-974d-43f8-a5a2-ec771b2d9297" }, "data": { "categories": [ { "name": "payment.state.success", "description": "An event sent when payment reaches a terminal successful status" }, { "name": "payment.state.failed", "description": "An event sent when payment reaches a terminal failed status" } ] } } } }, "schema": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "data": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryStructure" } } } } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "400": { "description": "Validation Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Unexpected Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } } } }, "/webhook/events": { "post": { "tags": [ "Webhooks" ], "description": "Register a webhook to one or multiple event categories to receive real-time notifications when specific events occur in your application.", "summary": "Register Webhook Event", "operationId": "registerWebhook", "requestBody": { "content": { "application/json;charset=UTF-8": { "schema": { "type": "object", "required": [ "applicationId", "categories", "callbackUrl" ], "properties": { "applicationId": { "type": "string", "format": "uuid" }, "categories": { "type": "array", "description": "One or more event categories for which the webhook will be triggered", "items": { "type": "string" } }, "callbackUrl": { "type": "object", "description": "Callback URLs where events will be sent. These must not contain any query parameters.", "required": [ "main" ], "properties": { "main": { "type": "object", "description": "Primary URL where events will be sent. It must not contain any query parameters.", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "A valid URL without query parameters." } } }, "backup": { "type": "object", "description": "Secondary URL where events will be sent whenever the primary URL is not responding. It must not contain any query parameters.", "properties": { "url": { "type": "string", "description": "A valid URL without query parameters." } } } } }, "metadata": { "$ref": "#/components/schemas/WebhookMetadata" } } } } } }, "responses": { "201": { "$ref": "#/components/responses/WebhookDetailsWithSecret" }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "400": { "description": "Validation Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "406": { "description": "Maximum number of registered webhooks has been reached", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/406-error-response" } } } } }, "500": { "description": "Unexpected Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/SubAppHeader" } ] }, "get": { "tags": [ "Webhooks" ], "description": "Retrieve the list of registered webhooks for your application", "summary": "Retrieve All Webhook Events", "operationId": "getRegisteredWebhooks", "responses": { "200": { "description": "Registered Webhooks", "content": { "application/json;charset=UTF-8": { "schema": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "data": { "type": "object", "properties": { "active": { "type": "array", "items": { "$ref": "#/components/schemas/RegisteredWebhookWithStatus" } } } } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "400": { "description": "Validation Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Unexpected Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } }, "parameters": [ { "$ref": "#/components/parameters/SubAppHeader" } ] } }, "/webhook/events/{webhook_id}": { "delete": { "tags": [ "Webhooks" ], "description": "Delete a webhook event for a specified webhook ID, unregistering it from receiving any further notifications for the subscribed event categories in your application.", "summary": "Delete Webhook Event", "operationId": "deleteWebhook", "parameters": [ { "$ref": "#/components/parameters/SubAppHeader" }, { "$ref": "#/components/parameters/WebhookIdParameter" } ], "responses": { "200": { "description": "Deleted", "content": { "application/json;charset=UTF-8": { "schema": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "data": { "$ref": "#/components/schemas/RegisteredWebhook" } } } } } }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "400": { "description": "Validation Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "404": { "description": "Webhook ID not found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/404-error-response" } } } } }, "500": { "description": "Unexpected Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } } } }, "/webhook/secrets/{webhook_id}": { "post": { "tags": [ "Webhooks" ], "description": "Reset webhook secret for a webhook that is already registered to your application", "summary": "Reset Webhook Secret", "operationId": "webhookSecretReset", "parameters": [ { "$ref": "#/components/parameters/SubAppHeader" }, { "$ref": "#/components/parameters/WebhookIdParameter" } ], "requestBody": { "content": { "application/json;charset=UTF-8": { "schema": { "type": "object", "required": [ "delay" ], "properties": { "delay": { "type": "number", "description": "delay in seconds", "minimum": 0, "maximum": 86400 } } } } } }, "responses": { "201": { "$ref": "#/components/responses/WebhookDetailsWithSecret" }, "401": { "description": "Authentication Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/401-error-response" } } } } }, "400": { "description": "Validation Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "404": { "description": "Webhook ID not found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/404-error-response" } } } } }, "500": { "description": "Unexpected Error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/500-error-response" } } } } } } } }, "/applications/{applicationId}/beneficiaries": { "post": { "tags": [ "Application Beneficiaries" ], "operationId": "createApplicationBeneficiary", "summary": "Create application beneficiary", "description": "Creation of beneficiaries for a given application.", "parameters": [ { "$ref": "#/components/parameters/ApplicationIdPath" } ], "requestBody": { "required": true, "description": "The beneficiary to be created.", "content": { "application/json": { "schema": { "type": "object", "description": "Application beneficiary details.", "required": [ "name", "accountIdentifier" ], "properties": { "name": { "type": "string", "description": "beneficiary name", "example": "John Doe" }, "accountIdentifier": { "$ref": "#/components/schemas/AccountIdentifier" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationBeneficiaryResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "429": { "description": "Too many requests", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Internal error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } } } }, "get": { "tags": [ "Application Beneficiaries" ], "operationId": "getApplicationBeneficiaries", "summary": "Get all application beneficiaries", "description": "Get all application beneficiaries from an application.", "parameters": [ { "$ref": "#/components/parameters/ApplicationIdPath" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "Application beneficiary paginated response.", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationBeneficiaryData" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Internal error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } } } } }, "/applications/{applicationId}/beneficiaries/{beneficiaryId}": { "get": { "tags": [ "Application Beneficiaries" ], "operationId": "getApplicationBeneficiaryById", "summary": "Get application beneficiary by id", "description": "Get user beneficiary by id.", "parameters": [ { "$ref": "#/components/parameters/ApplicationIdPath" }, { "$ref": "#/components/parameters/BeneficiaryIdPath" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationBeneficiaryResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Internal error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } } } }, "delete": { "tags": [ "Application Beneficiaries" ], "operationId": "deleteApplicationBeneficiaryById", "summary": "Delete application beneficiary by id", "description": "Delete application beneficiary.", "parameters": [ { "$ref": "#/components/parameters/ApplicationIdPath" }, { "$ref": "#/components/parameters/BeneficiaryIdPath" } ], "responses": { "204": { "description": "No Content." }, "400": { "description": "Invalid request", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Internal error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } } } } }, "/users/{userId}/beneficiaries": { "post": { "tags": [ "User Beneficiaries" ], "operationId": "createUserBeneficiary", "summary": "Create Beneficiary", "description": "Creation of beneficiaries for a given application User.", "parameters": [ { "$ref": "#/components/parameters/UserIdPath" }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "required": true, "description": "The beneficiary to be created.", "content": { "application/json": { "schema": { "type": "object", "description": "User Beneficiary details.", "required": [ "name", "accountIdentifier" ], "properties": { "name": { "type": "string", "description": "name of the beneficiary", "example": "John Doe" }, "accountIdentifier": { "$ref": "#/components/schemas/AccountIdentifier" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBeneficiaryResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "429": { "description": "Too many requests", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Internal error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } } } }, "get": { "tags": [ "User Beneficiaries" ], "operationId": "getUserBeneficiaries", "summary": "Get all users beneficiaries", "description": "Get all users beneficiaries from an userId.", "parameters": [ { "$ref": "#/components/parameters/UserIdPath" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The user beneficiary response.", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserBeneficiaryData" } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Internal error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } } } } }, "/users/{userId}/beneficiaries/{beneficiaryId}": { "patch": { "tags": [ "User Beneficiaries" ], "operationId": "patchUserBeneficiary", "summary": "Patch User Beneficiary", "description": "Patch the beneficiary details for a given application user and beneficiary", "parameters": [ { "$ref": "#/components/parameters/BeneficiaryIdPath" }, { "$ref": "#/components/parameters/UserIdPath" }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "description": "The JSON Patch instructions to patch the beneficiary", "required": true, "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "description": "Patch details to be applied to user.", "type": "object", "required": [ "op", "path", "value" ], "properties": { "op": { "$ref": "#/components/schemas/PatchOperation" }, "path": { "type": "string", "description": "The path to the target location" }, "value": { "type": "string", "description": "The value to be added, replaced or tested" } } } }, "examples": { "update-name": { "summary": "Updating beneficiary name", "value": [ { "op": "replace", "path": "/name", "value": "John Doe" } ] } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBeneficiaryResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "409": { "description": "Conflict", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "429": { "description": "Too many requests", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Internal error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } } } }, "get": { "tags": [ "User Beneficiaries" ], "operationId": "getUserBeneficiary", "summary": "Get beneficiary by id", "description": "Get user beneficiary by id.", "parameters": [ { "$ref": "#/components/parameters/BeneficiaryIdPath" }, { "$ref": "#/components/parameters/UserIdPath" }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBeneficiaryResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "429": { "description": "Too many requests", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Internal error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } } } }, "delete": { "tags": [ "User Beneficiaries" ], "operationId": "deleteUserBeneficiary", "summary": "Delete user beneficiary by id.", "description": "Delete user beneficiary by id.", "parameters": [ { "$ref": "#/components/parameters/BeneficiaryIdPath" }, { "$ref": "#/components/parameters/UserIdPath" }, { "$ref": "#/components/parameters/SubAppHeader" } ], "responses": { "204": { "description": "No Content." }, "400": { "description": "Invalid request", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "429": { "description": "Too many requests", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Internal error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } } } } }, "/users/{userId}/beneficiaries/{beneficiaryId}/approve": { "post": { "tags": [ "User Beneficiaries" ], "operationId": "approveBeneficiary", "summary": "Approve Beneficiary", "description": "End-user has approved the beneficiary details", "parameters": [ { "$ref": "#/components/parameters/BeneficiaryIdPath" }, { "$ref": "#/components/parameters/UserIdPath" }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBeneficiaryValidationRequest" }, "example": { "name": "John Doe", "match": { "status": "FULL_MATCH" }, "accountIdentifier": { "type": "IBAN", "identification": "GB33BUKB2020155555555" } } } } }, "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBeneficiaryResponse" }, "example": { "meta": { "tracingId": "e7b7636d-a041-4013-8a1b-34dc85b7d341" }, "data": { "beneficiaryId": "a5cc1d07-dd0b-469f-8ebd-f580e8314efd", "status": "VERIFIED", "details": { "name": "John Doe", "match": { "status": "FULL_MATCH" }, "accountIdentifier": { "type": "IBAN", "identification": "GB33BUKB2020155555555" } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "429": { "description": "Too many requests", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Internal error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } } } } }, "/users/{userId}/beneficiaries/{beneficiaryId}/reject": { "post": { "tags": [ "User Beneficiaries" ], "operationId": "rejectBeneficiary", "summary": "Reject Beneficiary", "description": "End-user has rejected the beneficiary details", "parameters": [ { "$ref": "#/components/parameters/BeneficiaryIdPath" }, { "$ref": "#/components/parameters/UserIdPath" }, { "$ref": "#/components/parameters/SubAppHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBeneficiaryValidationRequest" }, "example": { "meta": { "tracingId": "e7b7636d-a041-4013-8a1b-34dc85b7d341" }, "data": { "beneficiaryId": "a5cc1d07-dd0b-469f-8ebd-f580e8314efd", "details": { "name": "Albert", "match": { "status": "NO_MATCH" }, "accountIdentifier": { "type": "IBAN", "identification": "GB33BUKB2020155555555" } } } } } } }, "responses": { "200": { "description": "OK.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserBeneficiaryResponse" }, "example": { "meta": { "tracingId": "e7b7636d-a041-4013-8a1b-34dc85b7d341" }, "data": { "beneficiaryId": "a5cc1d07-dd0b-469f-8ebd-f580e8314efd", "status": "REJECTED", "details": { "name": "Albert", "match": { "status": "NO_MATCH" }, "accountIdentifier": { "type": "IBAN", "identification": "GB33BUKB2020155555555" } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "404": { "description": "Not Found", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } }, "500": { "description": "Internal error", "content": { "application/json;charset=UTF-8": { "schema": { "$ref": "#/components/schemas/ApiErrorResponseV2" }, "examples": { "Example-1": { "$ref": "#/components/examples/400-error-response" } } } } } } } } }, "components": { "parameters": { "EventTypeId": { "name": "eventTypeId", "in": "path", "required": true, "description": "Unique identifier of the event type (for which notifications will be sent). ", "schema": { "type": "string", "description": "Valid event type Id" } }, "SearchApplicationsParameters": { "in": "query", "name": "publicFilterValues", "style": "form", "explode": true, "schema": { "type": "object", "properties": { "applicationIds": { "type": "array", "description": "Sub-application ids to filter the results for. If provided, the results will only include sub-applications with the given ids. Non-existent ids will be ignored.", "maxItems": 15, "items": { "type": "string", "format": "uuid" } }, "offset": { "type": "integer", "description": "The number of results to skip.", "minimum": 0, "default": 0 }, "limit": { "type": "integer", "description": "The maximum number of results to return.", "minimum": 1, "maximum": 1000, "default": 1000 }, "sort": { "type": "string", "description": "The field to sort the results by.

Possible values:", "default": "name" } } } }, "WebhookIdParameter": { "name": "webhook_id", "in": "path", "description": "Registered webhook ID", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "format": "uuid" } }, "SubAppHeader": { "description": "The sub-application ID to which event type is being subscribed to", "in": "header", "name": "sub-application", "required": false, "schema": { "type": "string", "format": "uuid" } }, "ApplicationIdPath": { "description": "Yapily application Id", "in": "path", "name": "applicationId", "required": true, "schema": { "type": "string", "format": "uuid", "example": "6d97cf35-1000-4787-af16-7100912db9e4" } }, "BeneficiaryIdPath": { "in": "path", "name": "beneficiaryId", "required": true, "schema": { "$ref": "#/components/schemas/BeneficiaryId" } }, "UserIdPath": { "in": "path", "name": "userId", "required": true, "schema": { "type": "string", "format": "uuid", "example": "e7b7636d-a041-4013-8a1b-34dc85b7d341" } } }, "schemas": { "UserBeneficiaryResponse": { "type": "object", "description": "The user beneficiary response.", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/UserBeneficiaryData" } } }, "UserBeneficiaryData": { "type": "object", "description": "Beneficiary data response.", "properties": { "beneficiaryId": { "type": "string", "format": "uuid", "example": "e7b7636d-a041-4013-8a1b-34dc85b7d341", "description": "id of the beneficiary" }, "status": { "$ref" : "#/components/schemas/BeneficiaryStatus" }, "details": { "description": "Beneficiary response with the details of the VoP result.", "required": [ "name", "accountIdentifier" ], "properties": { "name": { "type": "string", "description": "name of the beneficiary", "example": "John Doe" }, "match": { "$ref": "#/components/schemas/UserBeneficiaryMatch" }, "accountIdentifier": { "$ref": "#/components/schemas/AccountIdentifier" } } } } }, "BeneficiaryStatus": { "description": "Status of the beneficiary check.", "type": "string", "enum": [ "PENDING", "VERIFIED", "REJECTED" ] }, "UserBeneficiaryValidationRequest": { "type": "object", "description": "Beneficiary request with the details of the VoP result.", "required": [ "name", "accountIdentifier" ], "properties": { "name": { "type": "string", "description": "name of the beneficiary", "example": "John Doe" }, "match": { "$ref": "#/components/schemas/UserBeneficiaryMatch" }, "accountIdentifier": { "$ref": "#/components/schemas/AccountIdentifier" } } }, "ApplicationBeneficiaryResponse": { "type": "object", "description": "Application beneficiary response.", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/ApplicationBeneficiaryData" } } }, "ApplicationBeneficiaryData": { "type": "object", "description": "Application beneficiary data response.", "properties": { "beneficiaryId": { "$ref": "#/components/schemas/BeneficiaryId" }, "details": { "type": "object", "required": [ "name", "accountIdentifier" ], "properties": { "name": { "type": "string", "description": "name of the beneficiary", "example": "John Doe" }, "accountIdentifier": { "$ref": "#/components/schemas/AccountIdentifier" } } } } }, "AccountIdentifier": { "type": "object", "description": "Account's details.", "required": [ "identification", "type" ], "properties": { "type": { "$ref": "#/components/schemas/AccountIdentifierType" }, "identification": { "type": "string", "description": "Account's IBAN", "example": "DE12345123451234512345123" } } }, "AccountIdentifierType": { "type": "string", "enum": [ "IBAN" ] }, "UserBeneficiaryMatch": { "type": "object", "description": "Details of the match given by the institution.", "properties": { "status": { "$ref": "#/components/schemas/BeneficiaryMatchStatus" }, "closeMatchName": { "type": "string", "example": "John Doe", "description": "the name returned by the institution, in a case of CLOSE_MATCH" } } }, "BeneficiaryMatchStatus": { "type": "string", "enum": [ "FULL_MATCH", "CLOSE_MATCH", "NO_MATCH", "EXEMPTED", "VERIFICATION_CHECK_NOT_POSSIBLE" ] }, "BeneficiaryId": { "type": "string", "format": "uuid", "example": "e7b7636d-a041-4013-8a1b-34dc85b7d341", "description": "Beneficiary Id" }, "Account": { "type": "object", "properties": { "id": { "description": "Unique identifier of the account.", "type": "string" }, "type": { "type": "string", "description": "Specifies the type of account e.g. (BUSINESS_CURRENT)." }, "description": { "description": "Product name as defined by the financial institution for this account", "type": "string" }, "balance": { "type": "number", "description": "Main / headline balance for the account.

Use of this field is recommended as fallback only. Instead, use of the typed balances (accountBalances) is recommended." }, "currency": { "description": "Currency the bank account balance is denoted in.

Specified as a 3-letter ISO 4217 currency code", "type": "string" }, "usageType": { "$ref": "#/components/schemas/UsageType" }, "accountType": { "$ref": "#/components/schemas/AccountType" }, "nickname": { "description": "Nickname of the account that was provided by the account owner.

May be used to aid identification of the account.", "type": "string" }, "details": { "description": "Supplementary specifications that might be provided by the Bank. These provide further characteristics about the account.", "type": "string" }, "accountNames": { "type": "array", "items": { "$ref": "#/components/schemas/AccountName" } }, "accountIdentifications": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AccountIdentification" } }, "accountBalances": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } }, "consolidatedAccountInformation": { "$ref": "#/components/schemas/ConsolidatedAccountInformation" } } }, "AccountApiListResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "paging": { "$ref": "#/components/schemas/FilteredClientPayloadListAccount" }, "tracingId": { "type": "string", "writeOnly": true } } }, "ApiResponseOfAccount": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/Account" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "AccountAuthorisationRequest": { "required": [ "institutionId" ], "type": "object", "properties": { "userUuid": { "type": "string", "description": "`User` for which the authorisation request was created.", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "__Conditional__. User-friendly identifier of the `User` that provides authorisation. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided.", "example": "user-234562290" }, "forwardParameters": { "description": "Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect.", "type": "array", "items": { "type": "string" } }, "institutionId": { "type": "string", "description": "__Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to.", "example": "yapily-mock" }, "callback": { "type": "string", "description": "__Optional__. The server to redirect the user to after the user completes the authorisation at the `Institution`.

See [Using a callback (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-optional) for more information.", "example": "https://display-parameters.com" }, "redirect": { "$ref": "#/components/schemas/RedirectRequest" }, "oneTimeToken": { "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.

See [Using a callback with an OTT (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-with-an-ott-optional) for more information.", "example": false }, "accountRequest": { "$ref": "#/components/schemas/AccountRequest" } } }, "AccountBalance": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AccountBalanceType" }, "dateTime": { "type": "string", "format": "date-time", "description": "Date and time of the reported balance." }, "balanceAmount": { "$ref": "#/components/schemas/Amount" }, "creditLineIncluded": { "type": "boolean", "description": "__Optional__. Indicates whether any credit lines are included in the balance." }, "creditLines": { "type": "array", "description": "__Optional__. Specifies the type of balance.", "items": { "$ref": "#/components/schemas/CreditLine" } } } }, "ExtendConsentRequest": { "required": [ "lastConfirmedAt" ], "type": "object", "properties": { "lastConfirmedAt": { "type": "string", "description": "__Mandatory__. The time that the user confirmed access to their account information", "format": "date-time", "example": "2022-08-16T10:59:53.288Z" } } }, "EmbeddedAccountAuthorisationRequest": { "required": [ "institutionId" ], "type": "object", "properties": { "userUuid": { "type": "string", "description": "`User` for which the authorisation request was created.", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "__Conditional__. The user-friendly reference to the `User` that will authorise the authorisation request. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided.", "example": "user-234562290" }, "forwardParameters": { "type": "array", "description": "Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect.", "items": { "type": "string" } }, "institutionId": { "type": "string", "description": "__Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to.", "example": "yapily-mock" }, "callback": { "type": "string", "description": "__Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`.

See [Using a callback (Optional)](https://docs.yapily.com/) for more information.", "example": "https://display-parameters.com" }, "redirect": { "$ref": "#/components/schemas/RedirectRequest" }, "oneTimeToken": { "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.

See [Using a callback with an OTT (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-with-an-ott-optional) for more information.", "example": false }, "userCredentials": { "$ref": "#/components/schemas/UserCredentials" }, "selectedScaMethod": { "$ref": "#/components/schemas/ScaMethod" }, "scaCode": { "type": "string", "description": "__Conditional__. Used to update the authorisation with the sca code received by the user from the `Institution` using the embedded account authorisation flow.

This is the penultimate step required in the embedded account authorisation flow to authorise the `Consent`. After sending the sca code, to obtain an authorised consent, the last step is to poll [Get Consent](https://docs.yapily.com/api/reference/#operation/getConsentById) until the `Institution` authorises the request and the `Consent` `status` transitions to `AUTHORIZED`.", "example": "325614" }, "accountRequest": { "$ref": "#/components/schemas/AccountRequest" } } }, "AccountIdentification": { "title": "Account Identifications", "required": [ "type", "identification" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AccountIdentificationType" }, "identification": { "title": "Account Identification", "type": "string", "description": "__Mandatory__. The value associated with the account identification type.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/intro-to-payment-execution/#account-identifications-combinations) for more information on the format of the values.", "example": "401016" } } }, "HostedVrpAccountIdentification": { "title": "Account Identifications", "required": [ "type", "identification" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/HostedVrpAccountIdentificationType" }, "identification": { "title": "Account Identification", "type": "string", "description": "__Mandatory__. The value associated with the account identification type.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/intro-to-payment-execution/#account-identifications-combinations) for more information on the format of the values.", "example": "401016" } } }, "AccountIdentificationResponse": { "title": "Account Identifications", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AccountIdentificationTypeResponse" }, "identification": { "title": "Account Identification", "type": "string", "description": "The value associated with the account identification type.

See [Account Identification Combinations](https://docs.yapily.com/pages/payments/payments-resources/intro-to-payment-execution/#account-identifications-combinations) for more information on the format of the values.", "example": "401016" } } }, "AccountInfo": { "required": [ "accountIdentification" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "__Conditional__. Unique identifier of the account.", "example": "500000000000000000000001" }, "accountIdentification": { "$ref": "#/components/schemas/AccountIdentification" } }, "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).

This can be specified in conjunction with `accountIdentifiersForTransaction` to generate a `Consent` that can both access the accounts balance and transactions." }, "AccountName": { "type": "object", "properties": { "name": { "description": "The bank account holder's name given by the account owner.", "type": "string" } } }, "AccountRequest": { "type": "object", "properties": { "transactionFrom": { "type": "string", "description": "__Optional__. Specifies the earliest date of the transaction records to be returned.

You must supply this field to retrieve transactions older than 90 days for banks accessed via the the [CBI Globe Gateway](https://docs.yapily.com/pages/data/financial-data-resources/data-restrictions/#cbi-globe-gateway).", "format": "date-time", "example": "2020-01-01T00:00:00Z" }, "transactionTo": { "type": "string", "description": "__Optional__. Specifies the latest date of the transaction records to be returned.", "format": "date-time", "example": "2021-01-01T00:00:00Z" }, "expiresAt": { "type": "string", "description": "__Optional__. Used to set a hard date for when the user's associated `Consent` will expire.

**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.

**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", "example": "2025-01-01T00:00:00Z" }, "accountIdentifiers": { "$ref": "#/components/schemas/AccountInfo" }, "accountIdentifiersForTransaction": { "type": "array", "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).

This can be specified in conjunction with `accountIdentifiersForBalance` to generate a `Consent` that can both access the accounts balance and transactions.", "items": { "$ref": "#/components/schemas/AccountInfo" } }, "accountIdentifiersForBalance": { "type": "array", "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).

This can be specified in conjunction with `accountIdentifiersForTransaction` to generate a `Consent` that can both access the accounts balance and transactions.", "items": { "$ref": "#/components/schemas/AccountInfo" } }, "featureScope": { "uniqueItems": true, "type": "array", "description": "__Optional__. Used to granularly specify the set of features that the user will give their consent for when requesting access to their account information. Depending on the `Institution`, this may also populate a consent screen which list these scopes before the user authorises.

This endpoint accepts allow all [Financial Data Features](/guides/financial-data/features/#feature-list) that the `Institution` supports.To find out which scopes an `Institution` supports, check [GET Institution](./#get-institution).", "items": { "$ref": "#/components/schemas/FeatureEnum" } } }, "description": "__Conditional__. Used to further specify details of the `Consent` to request

Conditions:
  1. Mandatory to specify the individual scopes to request from the user at the `Institution` for an account authorisation
  2. Mandatory to specify an expiry time on the created `Consent` at which time will render it unusable
  3. Mandatory to specify the date range that the created `Consent` will be able to access transactions for (given the range is support for the `Institution`)
" }, "AccountStatement": { "type": "object", "description": "Statement information belonging to the account.", "properties": { "id": { "description": "Unique identifier for the statement.", "type": "string" }, "startDateTime": { "type": "string", "description": "Date and time of when the statement period starts.", "format": "date-time" }, "endDateTime": { "type": "string", "description": "Date and time of when the statement period ends.", "format": "date-time" }, "creationDateTime": { "type": "string", "description": "Date and time of when the statement was created.", "format": "date-time" } } }, "AccountBalanceType": { "type": "string", "description": "Specifies the type of the stated account balance.", "enum": [ "CLOSING_AVAILABLE", "CLOSING_BOOKED", "CLOSING_CLEARED", "EXPECTED", "FORWARD_AVAILABLE", "INFORMATION", "INTERIM_AVAILABLE", "INTERIM_BOOKED", "INTERIM_CLEARED", "OPENING_AVAILABLE", "OPENING_BOOKED", "OPENING_CLEARED", "PREVIOUSLY_CLOSED_BOOKED", "AUTHORISED", "OTHER", "UNKNOWN" ] }, "AccountIdentificationType": { "title": "Account Identification Type", "type": "string", "description": "__Mandatory__. Used to describe the format of the account.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/intro-to-payment-execution/#account-identifications-combinations) for more information on when to specify each type.", "example": "SORT_CODE", "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" ] }, "HostedAccountRequest": { "type": "object", "description": "__Conditional__. Used to further specify details of the `Consent` to request

Conditions:
  1. Mandatory to specify the individual scopes to request from the user at the `Institution` for an account authorisation
  2. Mandatory to specify an expiry time on the created `Consent` at which time will render it unusable
  3. Mandatory to specify the date range that the created `Consent` will be able to access transactions for (given the range is support for the `Institution`)
", "properties": { "transactionFrom": { "type": "string", "description": "__Optional__. Specifies the earliest date of the transaction records to be returned.

You must supply this field to retrieve transactions older than 90 days for banks accessed via the the [CBI Globe Gateway](https://docs.yapily.com/pages/data/financial-data-resources/data-restrictions/#cbi-globe-gateway).", "format": "date-time", "example": "2020-01-01T00:00:00Z" }, "transactionTo": { "type": "string", "description": "__Optional__. Specifies the latest date of the transaction records to be returned.", "format": "date-time", "example": "2021-01-01T00:00:00Z" }, "expiresAt": { "type": "string", "description": "__Optional__. Used to set a hard date for when the user's associated `Consent` will expire.

**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.

**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", "example": "2025-01-01T00:00:00Z" }, "featureScope": { "uniqueItems": true, "type": "array", "description": "__Optional__. Used to granularly specify the set of features that the user will give their consent for when requesting access to their account information. Depending on the `Institution`, this may also populate a consent screen which list these scopes before the user authorises.

This endpoint accepts allow all [Financial Data Features](/guides/financial-data/features/#feature-list) that the `Institution` supports.To find out which scopes an `Institution` supports, check [GET Institution](./#get-institution).", "items": { "$ref": "#/components/schemas/FeatureEnum" } } } }, "HostedVrpAccountIdentificationType": { "title": "Account Identification Type", "type": "string", "description": "Used to describe the format of the account.

Allowed values:
MASKED_ACCOUNT_NUMBER
SORT_CODE
ACCOUNT_NUMBER ", "example": "SORT_CODE" }, "AccountIdentificationTypeResponse": { "title": "Account Identification Type", "type": "string", "description": "Used to describe the format of the account.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/intro-to-payment-execution/#account-identifications-combinations) for more information.", "example": "SORT_CODE", "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" ] }, "ApiResponseOfAccountStatement": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/AccountStatement" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "ApiListResponseOfAccountStatement": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccountStatement" } }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "paging": { "$ref": "#/components/schemas/FilteredClientPayloadListAccountStatement" }, "tracingId": { "type": "string", "writeOnly": true } } }, "AccountType": { "type": "string", "description": "The type of account e.g. (Credit Card, Savings).", "enum": [ "CASH_TRADING", "CASH_INCOME", "CASH_PAYMENT", "CHARGE_CARD", "CHARGES", "COMMISSION", "CREDIT_CARD", "CURRENT", "E_MONEY", "LIMITED_LIQUIDITY_SAVINGS_ACCOUNT", "LOAN", "MARGINAL_LENDING", "MONEY_MARKET", "MORTGAGE", "NON_RESIDENT_EXTERNAL", "OTHER", "OVERDRAFT", "OVERNIGHT_DEPOSIT", "PREPAID_CARD", "SALARY", "SAVINGS", "SETTLEMENT", "TAX", "UNKNOWN" ] }, "Address": { "title": "Address Details", "type": "object", "properties": { "addressLines": { "title": "Address Lines", "type": "array", "description": "__Optional__. The address line of the address", "example": [ "Ardenham Court" ], "items": { "type": "string" } }, "streetName": { "title": "Street", "type": "string", "description": "__Optional__. The street name of the address", "example": "Oxford Road" }, "buildingNumber": { "title": "Building Number", "type": "string", "description": "__Optional__. The building number of the address", "example": "45" }, "postCode": { "title": "Post Code", "type": "string", "description": "__Optional__. The post code of the address", "example": "HP19 3EQ" }, "townName": { "title": "Town", "type": "string", "description": "__Optional__. The town name of the address", "example": "Aylesbury" }, "county": { "title": "County", "type": "array", "description": "__Optional__. The list of counties for the address", "example": [ "Buckinghamshire" ], "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "__Conditional__. The 2-letter country code for the address.

An `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment", "example": "GB" }, "department": { "title": "Department", "type": "string", "description": "__Optional__. The department for the address", "example": "Unit 2" }, "subDepartment": { "title": "Sub-Department", "type": "string", "description": "__Optional__. The sub-department for the address", "example": "Floor 3" }, "addressType": { "$ref": "#/components/schemas/AddressTypeEnum" } }, "description": "__Conditional__. The address of the `Payee` or `Payer`.", "example": { "country": "GB" } }, "AddressResponse": { "title": "Address Details", "type": "object", "properties": { "addressLines": { "title": "Address Lines", "type": "array", "description": "The address line of the address", "example": [ "Ardenham Court" ], "items": { "type": "string" } }, "streetName": { "title": "Street", "type": "string", "description": "The street name of the address", "example": "Oxford Road" }, "buildingNumber": { "title": "Building Number", "type": "string", "description": "The building number of the address", "example": "45" }, "postCode": { "title": "Post Code", "type": "string", "description": "The post code of the address", "example": "HP19 3EQ" }, "townName": { "title": "Town", "type": "string", "description": "The town name of the address", "example": "Aylesbury" }, "county": { "title": "County", "type": "array", "description": "The list of counties for the address", "example": [ "Buckinghamshire" ], "items": { "type": "string" } }, "country": { "title": "Country", "type": "string", "description": "The 2-letter country code for the address.", "example": "GB" }, "department": { "title": "Department", "type": "string", "description": "The department for the address", "example": "Unit 2" }, "subDepartment": { "title": "Sub-Department", "type": "string", "description": "The sub-department for the address", "example": "Floor 3" }, "addressType": { "$ref": "#/components/schemas/AddressTypeEnumResponse" } }, "description": "The address of the `Payee` or `Payer`.", "example": { "country": "GB" } }, "AddressDetails": { "type": "object", "properties": { "addressLine": { "type": "string", "description": "Information, in free format text, that identifies a specific address." } } }, "AddressTypeEnum": { "title": "Address Type", "type": "string", "description": "__Optional__. The type of address", "enum": [ "BUSINESS", "CORRESPONDENCE", "DELIVERY_TO", "MAIL_TO", "PO_BOX", "POSTAL", "RESIDENTIAL", "STATEMENT", "UNKNOWN" ] }, "AddressTypeEnumResponse": { "title": "Address Type", "type": "string", "description": "The type of address", "enum": [ "BUSINESS", "CORRESPONDENCE", "DELIVERY_TO", "MAIL_TO", "PO_BOX", "POSTAL", "RESIDENTIAL", "STATEMENT", "UNKNOWN" ] }, "Amount": { "title": "Amount Details", "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "title": "Amount", "type": "number", "description": "__Mandatory__. The monetary value", "example": 10 }, "currency": { "title": "Currency", "type": "string", "description": "__Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code", "example": "GBP" } }, "description": "__Mandatory__. Monetary Amount." }, "AmountDetailsResponse": { "title": "Amount Details", "type": "object", "properties": { "amount": { "title": "Amount", "type": "number", "description": "The monetary value", "example": 10 }, "currency": { "title": "Currency", "type": "string", "description": "The [ISO 4217](https://www.xe.com/iso4217.php) currency code", "example": "GBP" } }, "description": "Monetary Amount." }, "ApiCall": { "type": "object" }, "ApiError": { "type": "object", "description": "Provides details of the error that has occurred.", "properties": { "code": { "type": "integer", "description": "__Mandatory__. Numeric `HTTP` status code associated with the error.", "format": "int32" }, "institutionError": { "$ref": "#/components/schemas/InstitutionError" }, "message": { "type": "string", "description": "__Mandatory__. Description of the exact error that has been experienced." }, "source": { "type": "string" }, "status": { "type": "string", "description": "__Mandatory__. Textual description of the `HTTP` error status type." }, "tracingId": { "type": "string", "description": "__Optional__. A unique identifier assigned by Yapily for the request that can be used for support purposes." } } }, "ApiResponseError": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/ApiError" }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } } }, "description": "Used to return errors from the bank from each request", "example": { "error": { "tracingId": "74b13ce8ed51419f92c5d609e04532de", "code": 424, "institutionError": { "errorMessage": "{\"Code\":\"500 Internal Server Error\",\"Id\":\"5ff8d331-4282-41e0-b5ef-1ac9ac39f009\",\"Message\":\"Technical Error. Please try again later\",\"Errors\":[{\"ErrorCode\":\"UK.OBIE.UnexpectedError\",\"Message\":\"There was a problem processing your request. Please try again later\"}]}", "httpStatusCode": 500 }, "source": "INSTITUTION", "status": "FAILED_DEPENDENCY" } } }, "ApiErrorResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/ErrorDetails" } }, "description": "Used to return errors from the bank from each request", "example": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 400, "status": "BAD_REQUEST", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "INVALID_REQUEST", "code": "INVALID_PROPERTY_UNEXPECTED_VALUE", "parameter": "$.payer.accountidentifications.type", "message": "Type Should be one of [PAN, SORT_CODE, ACCOUNT_NUMBER]", "institutionError": { "errorMessage": "{\"Code\":\"400 BadRequest\",\"Id\":\"3517bfc2-c3ee-4f2f-b4f8-12f62478e0d1\",\"Message\":\"No Resource found\",\"Errors\":[{\"ErrorCode\":\"UK.OBIE.Resource.NotFound\",\"Message\":\"No resource found corresponding to the consent id\"}]}", "httpStatusCode": 400 } } ] } } }, "ApiErrorResponseV2": { "type": "object", "description": "API Error Response", "properties": { "error": { "required": [ "tracingId", "code", "status", "issues" ], "type": "object", "properties": { "tracingId": { "type": "string", "description": "Unique identifier of the request, used by Yapily for support purposes" }, "code": { "type": "integer", "format": "int32", "description": "Numeric HTTP status code associated with the error" }, "status": { "type": "string", "description": "Textual description of the HTTP status" }, "supportUrl": { "type": "string", "description": "Link to where further information regarding the error can be found" }, "source": { "type": "string", "description": "Source of the error. This may be YAPILY, the INSTITUTION, or the USER" }, "issues": { "type": "array", "description": "List of issues relating to the error", "items": { "required": [ "message", "code" ], "type": "object", "description": "Detailed information regarding the issue that was experienced during processing of the request", "properties": { "type": { "type": "string", "description": "Category of the issue" }, "code": { "type": "string", "description": "5 digit Error Code that uniquely identifies the type of issue, for full list of error codes pelase check our documentation" }, "message": { "type": "string", "description": "Human readable description of the issue that was experienced" } } } } } } } }, "Application": { "type": "object", "description": "Information about the application.", "properties": { "uuid": { "type": "string", "description": "Unique identification for the `Application` as assigned by Yapily.", "format": "uuid" }, "name": { "type": "string", "description": "The individual name of the `Application`." }, "active": { "type": "boolean", "description": "States whether an `Application` is active." }, "authCallbacks": { "type": "array", "items": { "type": "string", "description": "URL'S used for redirecting the `User's` application after authentication has been completed." } }, "institutions": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Institution" } }, "media": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Media" } }, "created": { "type": "string", "description": "Date and time of when the application was created.", "format": "date-time" }, "updated": { "type": "string", "description": "Date and time of when the application was last updated.", "format": "date-time" } } }, "ApplicationUser": { "type": "object", "description": "Information about a user of an application.", "properties": { "uuid": { "type": "string", "description": "A unique identifier for the 'User' assigned by Yapily.", "format": "uuid" }, "applicationUuid": { "type": "string", "description": "Unique identifier of the application the user is associated with.", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "__Conditional__. The user-friendly reference to the `User`." }, "referenceId": { "type": "string" }, "createdAt": { "type": "string", "description": "Date and time of when the user was created.", "format": "date-time" }, "institutionConsents": { "type": "array", "items": { "$ref": "#/components/schemas/InstitutionConsent" } }, "vopOptOut": { "type": "boolean", "description": "__Optional__. A flag to indicate whether the user has opted out of VOP.", "default": false } } }, "BulkPaymentDetailsResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "type": "object", "title": "BulkPaymentDetailsData", "properties": { "id": { "type": "string", "description": "__Mandatory__. Unique identifier for the bulk payment transaction." }, "consentId": { "type": "string", "description": "__Mandatory__. Unique identifier of the consent related to bulk payment transaction." }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPaymentIndividualStatus" } } } } } }, "BulkPaymentIndividualStatus": { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "string", "description": "__Mandatory__. Unique identifier of the individual payment." }, "status": { "$ref": "#/components/schemas/PaymentStatus" }, "statusDetails": { "type": "object", "title": "BulkPaymentIndividualStatusDetails", "description": "__Conditional__. Details regarding the status of an individual payment within a bulk request. This object is conditionally returned, typically when the status is not `COMPLETED`.", "properties": { "code": { "type": "string", "description": "__Conditional__. The unique 4-digit error code identifying the specific issue. Refer to the official documentation for a comprehensive list of error codes" }, "reason": { "type": "string", "description": "__Optional__. A human-readable description providing additional context or the specific error message encountered." } }, "required": [ "code" ] } } }, "EmbeddedAccountAuthorisationResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the embedded account authorisation request.", "format": "uuid" }, "userUuid": { "type": "string", "description": "The `User` that the authorisation request was created for.", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "The user-friendly reference to the `User` that the authorisation request was created for." }, "referenceId": { "type": "string" }, "institutionId": { "type": "string", "description": "The `Institution` the authorisation request was sent to." }, "status": { "$ref": "#/components/schemas/AuthorisationStatus" }, "createdAt": { "type": "string", "description": "Date and time the embedded authorisation was created by the application user.", "format": "date-time" }, "transactionFrom": { "type": "string", "description": "When performing a transaction query using the consent, this is the earliest date of transaction records that can be retrieved.", "format": "date-time" }, "transactionTo": { "type": "string", "description": "When performing a transaction query using the consent, this is the latest date of transaction records that can be retrieved.", "format": "date-time" }, "expiresAt": { "type": "string", "description": "Date and time the embedded authorisation expires. Re-authorisation is needed to retain access.", "format": "date-time" }, "timeToExpireInMillis": { "type": "integer", "format": "int64", "deprecated": true }, "timeToExpire": { "type": "string", "format": "iso8601" }, "featureScope": { "uniqueItems": true, "description": "The set of features the consent provides access to.", "type": "array", "items": { "$ref": "#/components/schemas/FeatureEnum" } }, "consentToken": { "type": "string", "description": "Represents the authorisation to gain access to the requested features. Required to access account information." }, "state": { "type": "string", "description": "Correlation ID used when handshaking with a new institution via OAuth2 registration." }, "authorizedAt": { "type": "string", "description": "Date and time the request was authorised by the `Institution`.", "format": "date-time" }, "institutionConsentId": { "type": "string", "description": "Identification of the consent at the `Institution`." }, "authorisationUrl": { "type": "string" }, "qrCodeUrl": { "type": "string", "description": "The URL link for the QR code that may be scanned via a mobile device to make an authorisation redirect to the bank (authURL encoded)." }, "scaMethods": { "type": "array", "description": "List of `SCA methods` that the `Institution` supports and are available for selection.", "items": { "$ref": "#/components/schemas/ScaMethod" } }, "selectedScaMethod": { "$ref": "#/components/schemas/ScaMethod" } } }, "ApiResponseOfEmbeddedAccountAuthorisationResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/EmbeddedAccountAuthorisationResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "AccountAuthorisationResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the account authorisation request.

The `consentID` used to [retrieve a consent](/api/reference/#operation/getConsentById).", "format": "uuid" }, "userUuid": { "type": "string", "description": "The `User` that the authorisation request was created for.", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "The user-friendly reference to the `User` that the authorisation request was created for." }, "referenceId": { "type": "string" }, "institutionId": { "type": "string", "description": "The `Institution` the authorisation request was sent to." }, "status": { "$ref": "#/components/schemas/AuthorisationStatus" }, "createdAt": { "type": "string", "description": "Date and time the consent was created.", "format": "date-time" }, "transactionFrom": { "type": "string", "description": "When performing a transaction query using the consent, this is the earliest date of transaction records that can be retrieved.", "format": "date-time" }, "transactionTo": { "type": "string", "description": "When performing a transaction query using the consent, this is the latest date of transaction records that can be retrieved.", "format": "date-time" }, "expiresAt": { "type": "string", "description": "Date and time the authorisation expires. Re-authorisation is needed to retain access.", "format": "date-time" }, "timeToExpireInMillis": { "type": "integer", "format": "int64", "deprecated": true }, "timeToExpire": { "type": "string", "format": "iso8601" }, "featureScope": { "uniqueItems": true, "description": "The set of features the consent provides access to.", "type": "array", "items": { "$ref": "#/components/schemas/FeatureEnum" } }, "consentToken": { "type": "string", "description": "Represents the authorisation to gain access to the requested features. Required to access account information." }, "state": { "type": "string", "description": "Correlation ID used with the `Institution` during the authorisation process." }, "authorizedAt": { "type": "string", "description": "Date and time the request was authorised by the `Institution`.", "format": "date-time" }, "lastConfirmedAt": { "type": "string", "description": "The time the PSU last confirmed access to their account information, either through full authentication with the institution, or through reconfirmation with the TPP.", "format": "date-time" }, "reconfirmBy": { "type": "string", "description": "The date and time the consent must be reconfirmed by to ensure continued access to the account information.", "format": "date-time" }, "institutionConsentId": { "type": "string", "description": "Unique identifier of the consent assigned by the `Institution`." }, "authorisationUrl": { "type": "string" }, "qrCodeUrl": { "type": "string", "description": "The URL link for the QR code that may be scanned via a mobile device to make an authorisation redirect to the bank (authURL encoded)." } } }, "AuthorisationStatus": { "description": "Current status of the embedded authorisation request in code form.", "type": "string", "enum": [ "AWAITING_AUTHORIZATION", "AWAITING_FURTHER_AUTHORIZATION", "AWAITING_RE_AUTHORIZATION", "AUTHORIZED", "CONSUMED", "REJECTED", "REVOKED", "FAILED", "EXPIRED", "UNKNOWN", "INVALID", "AWAITING_DECOUPLED_PRE_AUTHORIZATION", "AWAITING_PRE_AUTHORIZATION", "PRE_AUTHORIZED", "AWAITING_DECOUPLED_AUTHORIZATION", "AWAITING_SCA_METHOD", "AWAITING_SCA_CODE" ] }, "ApiResponseOfAccountAuthorisationResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/AccountAuthorisationResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "TransactionBalance": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AccountBalanceType" }, "balanceAmount": { "$ref": "#/components/schemas/Amount" } } }, "Balances": { "type": "object", "properties": { "mainBalanceAmount": { "$ref": "#/components/schemas/Amount" }, "balances": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } } } }, "ApiResponseOfBalances": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/Balances" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "Beneficiary": { "type": "object", "description": "Account information belonging to the target beneficiary (person/ business).", "properties": { "id": { "type": "string", "description": "Unique identifier of the `beneficiary`." }, "reference": { "type": "string", "description": "A creditor reference that is requested to be used for all payment instructions to this beneficiary." }, "payee": { "$ref": "#/components/schemas/BeneficiaryPayee" }, "trusted": { "type": "boolean", "description": "Indicates whether the account owner has stated that this beneficiary should be trusted. This often results in reduced authentication and authorisation requirements on payments to the beneficiary." } } }, "BeneficiaryPayee": { "description": "__Mandatory__. Account details belonging to the `Beneficiary Payee` (person/ business). You must define this in your payment request along with all of the nested mandatory properties.", "required": [ "accountIdentifications" ], "type": "object", "properties": { "name": { "type": "string", "description": "The account holder name of the beneficiary.", "example": "Jane Doe" }, "accountIdentifications": { "type": "array", "description": "__Mandatory__. The account identifications that identify the `BeneficiaryPayee` bank account.", "example": [ { "identification": "401016", "type": "SORT_CODE" }, { "identification": "71518920", "type": "ACCOUNT_NUMBER" } ], "items": { "$ref": "#/components/schemas/AccountIdentification" }, "uniqueItems": true }, "address": { "$ref": "#/components/schemas/Address" } } }, "ApiListResponseOfBeneficiary": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Beneficiary" } }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "BulkPaymentAuthorisationRequest": { "required": [ "institutionId" ], "type": "object", "properties": { "userUuid": { "type": "string", "format": "uuid", "description": "__Conditional__. The reference to the `User` that will authorise the authorisation request using the Yapily generated UUID. Either the `userUuid` or `applicationUserId` must be provided.", "example": "e006a012-c306-4355-a6a1-99bf69ae5171" }, "applicationUserId": { "type": "string", "description": "__Conditional__. The user-friendly reference to the `User` that will authorise the authorisation request. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided.", "example": "user-234562290" }, "forwardParameters": { "type": "array", "description": "Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect.", "items": { "type": "string" } }, "institutionId": { "type": "string", "description": "__Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to.", "example": "yapily-mock" }, "callback": { "type": "string", "description": "__Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`.

See [Using a callback (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-optional) for more information.", "example": "https://display-parameters.com" }, "redirect": { "$ref": "#/components/schemas/RedirectRequest" }, "oneTimeToken": { "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.

See [Using a callback with an OTT (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-with-an-ott-optional) for more information.", "example": false }, "paymentRequest": { "$ref": "#/components/schemas/BulkPaymentRequest" } } }, "BulkPaymentEmbeddedAuthorisationRequest": { "required": [ "institutionId" ], "type": "object", "properties": { "userUuid": { "type": "string", "format": "uuid", "description": "__Conditional__. The reference to the `User` that will authorise the authorisation request using the Yapily generated UUID. Either the `userUuid` or `applicationUserId` must be provided.", "example": "e006a012-c306-4355-a6a1-99bf69ae5171" }, "applicationUserId": { "type": "string", "description": "__Conditional__. The user-friendly reference to the `User` that will authorise the authorisation request. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided.", "example": "user-234562290" }, "institutionId": { "type": "string", "description": "__Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to.", "example": "yapily-mock" }, "callback": { "type": "string", "description": "__Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`.

See [Using a callback (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-optional) for more information.", "example": "https://display-parameters.com" }, "redirect": { "$ref": "#/components/schemas/RedirectRequest" }, "oneTimeToken": { "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.

See [Using a callback with an OTT (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-with-an-ott-optional) for more information.", "example": false }, "paymentRequest": { "$ref": "#/components/schemas/BulkPaymentRequest" }, "userCredentials": { "$ref": "#/components/schemas/UserCredentials" }, "selectedScaMethod": { "$ref": "#/components/schemas/ScaMethod" }, "scaCode": { "type": "string", "description": "__Conditional__. Used to update the authorisation with the sca code received by the user from the `Institution` using the embedded payment authorisation flow.

This is the penultimate step required in the embedded payment authorisation flow to authorise the `Consent`. After sending the sca code, to obtain an authorised consent, the last step is to poll [Get Consent](https://docs.yapily.com/api/reference/#operation/getConsentById) until the `Institution` authorises the request and the `Consent` `status` transitions to `AUTHORIZED`.", "example": "325614" } }, "description": "The request body containing a `BulkPaymentEmbeddedAuthorisationRequest` json payload" }, "BulkPaymentRequest": { "required": [ "payments" ], "type": "object", "properties": { "payments": { "type": "array", "description": "__Mandatory__. The array of `PaymentRequest` objects to initiate in the bulk payment.", "items": { "$ref": "#/components/schemas/PaymentRequest" } }, "originatorIdentificationNumber": { "type": "string", "description": "__Conditional__. The identification number of the originator." }, "executionDateTime": { "type": "string", "description": "__Optional__. Used to schedule the bulk payment to be executed at a future date if supported by the `Institution`. This value establishes the requirement for the subsequent payment submission. The final payment request must occur on the same calendar day as this timestamp to pass validation.", "format": "date-time" } }, "description": "The payment request object defining the details of the bulk payment" }, "SubmitBulkPaymentRequest": { "required": [ "payments" ], "type": "object", "properties": { "idempotencyId": { "type": "string", "minLength": 1, "maxLength": 40, "pattern": "^\\S{1,40}$", "description": "__Optional__. An alphanumeric string (1-40 chars) used for idempotency. Unique per consent ID for 24 hours. Prevents duplicate bulk file payment submissions.", "example": "1cc3e60d-5500-42be-aaeb-3c5e2f5ed048" }, "payments": { "type": "array", "description": "__Mandatory__. The array of `PaymentRequest` objects to initiate in the bulk payment.", "items": { "$ref": "#/components/schemas/PaymentRequest" } }, "originatorIdentificationNumber": { "type": "string", "description": "__Conditional__. The identification number of the originator." }, "executionDateTime": { "type": "string", "description": "__Optional__. Used to schedule the bulk payment to be executed at a future date if supported by the `Institution`. This value must fall on the same calendar day as the `executionDateTime` provided in the consent/authorisation phase. If the dates do not match, the bulk file payment will fail.", "format": "date-time" } }, "description": "The payment request object defining the details of the bulk payment" }, "Categorisation": { "type": "object", "description": "Income and Expense categorisation that the Yapily categorisation engine has determined for the transaction.", "properties": { "categories": { "type": "array", "items": { "type": "string" } }, "source": { "type": "string" } } }, "GetCategoriesResponse": { "type": "object", "properties": { "labels": { "type": "array", "items": { "type": "string" } } } }, "ChargeBearerType": { "type": "string", "description": "__Conditional__. Depending on the bank and payment type for international Euro payments. The field ChargeBearer specifies which party/parties will bear the charges associated with the processing of the payment transaction. Valid values are:", "enum": [ "DEBT", "CRED", "SHAR", "SLEV" ] }, "PaymentChargeDetails": { "type": "object", "description": "Details the charges that will apply to the payment.", "properties": { "chargeAmount": { "$ref": "#/components/schemas/Amount" }, "chargeType": { "description": "__Mandatory__. Specifies the nature of the transaction charge e.g. (Bank transfer fees).", "type": "string" }, "chargeTo": { "description": "__Mandatory__. States which party of the payment bears the charges.", "type": "string" } } }, "Consent": { "type": "object", "description": "Consent detailing the requested authorisation from a user to a specific `Institution`.", "properties": { "id": { "type": "string", "description": "Unique identifier of the consent.", "format": "uuid" }, "userUuid": { "type": "string", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "__Conditional__. The user-friendly reference to the `User` that will authorise the authorisation request. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided." }, "referenceId": { "type": "string" }, "institutionId": { "type": "string", "description": "__Mandatory__. The `Institution` the authorisation request is sent to." }, "status": { "$ref": "#/components/schemas/AuthorisationStatus" }, "createdAt": { "type": "string", "description": "Date and time of when the consent was created.", "format": "date-time" }, "transactionFrom": { "type": "string", "description": "When performing a transaction query using the consent, this is the earliest date of transaction records that can be retrieved.", "format": "date-time" }, "transactionTo": { "type": "string", "description": "When performing a transaction query using the consent, this is the latest date of transaction records that can be retrieved.", "format": "date-time" }, "expiresAt": { "type": "string", "description": "Date and time of when the authorisation will expire by. Reauthorisation will be needed to retain access.", "format": "date-time" }, "timeToExpireInMillis": { "type": "integer", "format": "int64", "deprecated": true }, "timeToExpire": { "type": "string", "format": "iso8601" }, "featureScope": { "uniqueItems": true, "description": "The set of features that the consent will provide access to.", "type": "array", "items": { "$ref": "#/components/schemas/FeatureEnum" } }, "consentToken": { "type": "string", "description": "Represents the authorisation to gain access to the requested features. Required to access account information or make a payment request." }, "state": { "type": "string", "description": "Correlation ID used with the `Institution` during the authorisation process." }, "authorizedAt": { "type": "string", "description": "Date and time of when the request was authorised by the Institution.", "format": "date-time" }, "lastConfirmedAt": { "type": "string", "description": "The time that the PSU last confirmed access to their account information, either through full authentication with the institution, or through reconfirmation with the TPP.", "format": "date-time" }, "reconfirmBy": { "type": "string", "description": "The time by which the consent should be reconfirmed to ensure continued access to the account information.", "format": "date-time" }, "institutionConsentId": { "type": "string", "description": "Identification of the consent at the Institution." }, "isDeletedByInstitution": { "type": "boolean", "description": "Denotes whether the consent has been deleted on the institution side or not when a DELETE method is executed on a Yapily consent if that functionality is provided by the institution", "example": false } } }, "ApiListResponseOfConsent": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Consent" } }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "paging": { "$ref": "#/components/schemas/FilteredClientPayloadListConsent" }, "tracingId": { "type": "string", "writeOnly": true } } }, "ApiResponseOfConsent": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/Consent" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "ConsentAuthCodeRequest": { "required": [ "authCode", "authState" ], "type": "object", "properties": { "authCode": { "type": "string", "description": "__Mandatory__. The authorisation code", "example": "6b965fbb-ff09-4afa-b897-90c34797cb8f" }, "authState": { "type": "string", "description": "__Mandatory__. The authorisation state", "example": "1270cb2ffc4842b78953afa2228e0a87" } }, "description": "The request body containing the `ConsentAuthCodeRequest` json payload" }, "ConsentDeleteResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "__Conditional__. User-friendly identifier of the `User` that provides authorisation. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided.", "format": "uuid" }, "deleteStatus": { "$ref": "#/components/schemas/DeleteStatusEnum" }, "institutionId": { "type": "string", "description": "__Mandatory__. The `Institution` the authorisation request is sent to." }, "institutionConsentId": { "type": "string", "description": "Identification of the consent at the Institution." }, "creationDate": { "type": "string", "description": "Date and time of when the consent was authorised.", "format": "date-time" } } }, "ConsolidatedAccountInformation": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the consolidated account. When used in Get Account Transactions calls, the transactions between the sub-accounts will not be reported" }, "accountBalances": { "type": "array", "items": { "$ref": "#/components/schemas/AccountBalance" } } }, "description": "Summary information regarding account balances of the overall account provided by the bank" }, "ApiResponseOfConsentDeleteResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/ConsentDeleteResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "Country": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Country name." }, "countryCode2": { "type": "string", "description": "Two character ISO 3166 country code." }, "bic": { "type": "string", "description": "Bank Identifier Code." } }, "description": "An array of `Country` denoting which regions the `Institution` provides coverage for" }, "CredentialsType": { "type": "string", "description": "The type of credentials required to register the `Institution`", "enum": [ "OAUTH1", "OAUTH2", "OAUTH2_NOSECRET", "OAUTH2_SIGNATURE", "OPEN_BANKING_UK_MANUAL", "OPEN_BANKING_UK_AUTO", "OPEN_BANKING_IBM", "OPEN_BANKING_AUTO", "OPEN_BANKING_AUTO_EMAIL", "OPEN_BANKING_MANUAL", "OPEN_BANKING_WITH_TPP_ID_AND_SECRET", "API_KEY", "OPEN_BANKING_NO_KEY", "OPEN_BANKING_NO_TRANSPORT", "TOKEN_IO" ] }, "CreditLine": { "type": "object", "description": "__Mandatory__. Details whether the account has access to a credit line from an `Institution`.", "properties": { "type": { "$ref": "#/components/schemas/CreditLineType" }, "creditLineAmount": { "$ref": "#/components/schemas/Amount" } } }, "CreditLineType": { "type": "string", "description": "__Mandatory__. The type of credit that has been provided.", "enum": [ "AVAILABLE", "CREDIT", "EMERGENCY", "PRE_AGREED", "TEMPORARY", "OTHER", "UNKNOWN" ] }, "CurrencyExchange": { "type": "object", "description": "Provides details on the currrency exchange.", "properties": { "sourceCurrency": { "type": "string", "description": "Currency from which an amount is to be converted." }, "targetCurrency": { "type": "string", "description": "Currency to which an amount is to be converted." }, "unitCurrency": { "type": "string", "description": "The currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP." }, "exchangeRate": { "type": "number", "description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency." } } }, "DeleteStatusEnum": { "type": "string", "description": "Indicates the outcome of the delete request.", "enum": [ "SUCCESS", "FAILED" ] }, "DirectDebitResponse": { "type": "object", "properties": { "id": { "type": "string" }, "statusDetails": { "$ref": "#/components/schemas/PaymentStatusDetails" }, "payeeDetails": { "$ref": "#/components/schemas/DirectDebitPayee" }, "reference": { "type": "string" }, "previousPaymentAmount": { "$ref": "#/components/schemas/Amount" }, "previousPaymentDateTime": { "type": "string", "format": "date-time" } } }, "DirectDebitPayee": { "type": "object", "properties": { "name": { "type": "string", "description": "__Mandatory__. The account holder name.", "example": "Tempus Risus Company" } } }, "EnrichedTransaction": { "description": "Details of the transaction, identified by Yapily data services.", "properties": { "transactionId": { "type": "string", "description": "Unique identifier of the transaction", "example": "c51e3bee-36fb-4c0a-8441-d6ba2056fe87" }, "transactionInformation": { "type": "string", "description": "Information for the transaction", "example": "Amazon Marketplace" }, "amount": { "example": 21.99, "type": "number", "description": "Monetary amount." }, "institution": { "type": "string", "description": "The `Institution` that the transaction is sent to.", "example": "starling" }, "bookingDateTime": { "type": "string", "format": "date-time", "description": "Date and time of when a transaction entry occured and was posted to the account servicer's books.", "example": "2020-04-24T00:30:19.951Z" } } }, "EnrichedWrapper": { "description": "Details of income and expenditure streams, identified by Yapily data services.", "required": [ "incomeStreams", "expenditureStreams", "recentlyTerminatedIncomeStreams", "recentlyTerminatedExpenditureStreams" ], "properties": { "incomeStreams": { "type": "array", "description": "Lists all possible income streams identified for the `Application User`.", "items": { "$ref": "#/components/schemas/TransactionStream" } }, "expenditureStreams": { "type": "array", "description": "Lists all possible expenditure streams identified for the `Application User`.", "items": { "$ref": "#/components/schemas/TransactionStream" } }, "recentlyTerminatedIncomeStreams": { "type": "array", "description": "A list of terminated transaction income streams", "items": { "$ref": "#/components/schemas/TerminatedTransactionStream" } }, "recentlyTerminatedExpenditureStreams": { "type": "array", "description": "A list of terminated transaction expenditure streams", "items": { "$ref": "#/components/schemas/TerminatedTransactionStream" } } }, "type": "object" }, "Enrichment": { "type": "object", "description": "Enriched data that has been derived by Yapily using it's data processing and machine learning techniques.", "properties": { "categorisation": { "$ref": "#/components/schemas/Categorisation" }, "transactionHash": { "$ref": "#/components/schemas/TransactionHash" }, "cleansedDescription": { "type": "string", "description": "Cleaned version of the `Transaction Description` that removes miscellaneous, generic and unhelpful text." }, "merchant": { "$ref": "#/components/schemas/EnrichmentMerchant" }, "location": { "type": "string", "description": "The location of where the transaction took place." }, "paymentProcessor": { "type": "string", "description": "A payment provider that manages (credit/debit) transactions between the `Institution` and the merchant." }, "correctedDate": { "type": "string", "description": "The likely date and time on which the transaction took place. This is distinct from `Booking Date Time` which usually refers to the post-clearing value.", "format": "date-time" } } }, "EnrichmentMerchant": { "type": "object", "description": "Details of the merchant, identified by Yapily data services.", "properties": { "merchantName": { "type": "string", "description": "The name of the indivdual merchant involved in the transaction e.g. (TESCO Petrol)." }, "parentGroup": { "type": "string", "description": "The parent organisation that the merchant belongs to e.g. (TESCO)." } } }, "EnvironmentType": { "type": "string", "description": "The environment type.

See [Institution Configuration](https://docs.yapily.com/pages/key-concepts/institutions/#configuration) for more information", "enum": [ "SANDBOX", "MOCK", "LIVE" ] }, "ExchangeRateInformation": { "required": [ "rateType", "unitCurrency" ], "type": "object", "properties": { "unitCurrency": { "type": "string", "description": "__Mandatory__. The currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is `GBP`." }, "rate": { "type": "number", "description": "__Optional__. The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency." }, "rateType": { "$ref": "#/components/schemas/RateTypeEnum" }, "foreignExchangeContractReference": { "type": "string", "description": "__Optional__. The unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent." } }, "description": "__Optional__. Used to provide details on the currency exchange rate and contract." }, "ExchangeRateInformationResponse": { "required": [ "rateType", "unitCurrency" ], "type": "object", "properties": { "unitCurrency": { "type": "string", "description": "__Mandatory__. The currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is `GBP`." }, "rate": { "type": "number", "description": "__Optional__. The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency." }, "rateType": { "$ref": "#/components/schemas/RateTypeEnum" }, "foreignExchangeContractReference": { "type": "string", "description": "__Optional__. The unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent." }, "exchangeRateExpiryDate": { "type": "string", "format": "date-time" } } }, "ApiListResponseOfDirectDebitResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DirectDebitResponse" } }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "paging": { "$ref": "#/components/schemas/FilteredClientPayloadListDirectDebitResponse" }, "tracingId": { "type": "string", "writeOnly": true } } }, "FeatureEnum": { "type": "string", "description": "Used to describe what functions are supported by the associated `Institution`.

For more information on each feature, see the following links: ", "enum": [ "INITIATE_PRE_AUTHORISATION", "INITIATE_PRE_AUTHORISATION_ACCOUNTS", "INITIATE_PRE_AUTHORISATION_PAYMENTS", "INITIATE_ACCOUNT_REQUEST", "INITIATE_EMBEDDED_ACCOUNT_REQUEST", "ACCOUNT_REQUEST_DETAILS", "ACCOUNTS", "ACCOUNT", "ACCOUNT_TRANSACTIONS", "ACCOUNT_STATEMENTS", "ACCOUNT_STATEMENT", "ACCOUNT_STATEMENT_FILE", "ACCOUNT_SCHEDULED_PAYMENTS", "ACCOUNT_DIRECT_DEBITS", "ACCOUNT_PERIODIC_PAYMENTS", "ACCOUNT_TRANSACTIONS_WITH_MERCHANT", "IDENTITY", "ACCOUNTS_WITHOUT_BALANCE", "ACCOUNT_WITHOUT_BALANCE", "ACCOUNT_BALANCES", "INITIATE_SINGLE_PAYMENT_SORTCODE", "EXISTING_PAYMENT_INITIATION_DETAILS", "CREATE_SINGLE_PAYMENT_SORTCODE", "EXISTING_PAYMENTS_DETAILS", "INITIATE_DOMESTIC_SINGLE_PAYMENT", "INITIATE_EMBEDDED_DOMESTIC_SINGLE_PAYMENT", "CREATE_DOMESTIC_SINGLE_PAYMENT", "INITIATE_EMBEDDED_BULK_PAYMENT", "INITIATE_DOMESTIC_SINGLE_INSTANT_PAYMENT", "CREATE_DOMESTIC_SINGLE_INSTANT_PAYMENT", "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT", "CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT", "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING", "CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_SWEEPING", "INITIATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL", "CREATE_DOMESTIC_VARIABLE_RECURRING_PAYMENT_COMMERCIAL", "INITIATE_DOMESTIC_SCHEDULED_PAYMENT", "CREATE_DOMESTIC_SCHEDULED_PAYMENT", "INITIATE_DOMESTIC_PERIODIC_PAYMENT", "CREATE_DOMESTIC_PERIODIC_PAYMENT", "PERIODIC_PAYMENT_FREQUENCY_EXTENDED", "INITIATE_INTERNATIONAL_SCHEDULED_PAYMENT", "CREATE_INTERNATIONAL_SCHEDULED_PAYMENT", "INITIATE_INTERNATIONAL_PERIODIC_PAYMENT", "CREATE_INTERNATIONAL_PERIODIC_PAYMENT", "INITIATE_INTERNATIONAL_SINGLE_PAYMENT", "CREATE_INTERNATIONAL_SINGLE_PAYMENT", "INITIATE_BULK_PAYMENT", "CREATE_BULK_PAYMENT", "EXISTING_BULK_PAYMENT_DETAILS", "TRANSFER", "OPEN_DATA_PERSONAL_CURRENT_ACCOUNTS", "OPEN_DATA_ATMS", "READ_DOMESTIC_SINGLE_REFUND", "READ_DOMESTIC_SCHEDULED_REFUND", "READ_DOMESTIC_PERIODIC_PAYMENT_REFUND", "READ_INTERNATIONAL_SINGLE_REFUND", "READ_INTERNATIONAL_SCHEDULED_REFUND", "ACCOUNT_BENEFICIARIES", "INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS", "INITIATE_ONETIME_PRE_AUTHORISATION_ACCOUNTS", "INITIATE_ONETIME_PRE_AUTHORISATION", "VARIABLE_RECURRING_PAYMENT_FUNDS_CONFIRMATION" ] }, "FilterAndSort": { "type": "object", "properties": { "from": { "type": "string", "description": "__Optional__. The earliest date and time of resources / records that should be returned.", "format": "date-time" }, "before": { "type": "string", "description": "__Optional__. The latest date and time of resources / records that should be returned.", "format": "date-time" }, "limit": { "type": "integer", "description": "__Optional__. The maximum number of resources / records that should be returned.", "format": "int32" }, "sort": { "$ref": "#/components/schemas/SortEnum" }, "offset": { "type": "integer", "format": "int32" }, "cursor": { "type": "string" } } }, "FilteredClientPayloadListAccount": { "type": "object", "properties": { "apiCall": { "$ref": "#/components/schemas/ApiCall" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "nextCursorHash": { "type": "string" }, "nextLink": { "type": "string" }, "pagingMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FilterAndSort" } }, "totalCount": { "type": "integer", "format": "int64" } } }, "FilteredClientPayloadListAccountStatement": { "type": "object", "properties": { "apiCall": { "$ref": "#/components/schemas/ApiCall" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccountStatement" } }, "nextCursorHash": { "type": "string" }, "nextLink": { "type": "string" }, "pagingMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FilterAndSort" } }, "totalCount": { "type": "integer", "format": "int64" } } }, "FilteredClientPayloadListConsent": { "type": "object", "properties": { "apiCall": { "$ref": "#/components/schemas/ApiCall" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Consent" } }, "nextCursorHash": { "type": "string" }, "nextLink": { "type": "string" }, "pagingMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FilterAndSort" } }, "totalCount": { "type": "integer", "format": "int64" } } }, "FilteredClientPayloadListDirectDebitResponse": { "type": "object", "properties": { "apiCall": { "$ref": "#/components/schemas/ApiCall" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DirectDebitResponse" } }, "nextCursorHash": { "type": "string" }, "nextLink": { "type": "string" }, "pagingMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FilterAndSort" } }, "totalCount": { "type": "integer", "format": "int64" } } }, "FilteredClientPayloadListInstitution": { "type": "object", "properties": { "apiCall": { "$ref": "#/components/schemas/ApiCall" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Institution" } }, "nextCursorHash": { "type": "string" }, "nextLink": { "type": "string" }, "pagingMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FilterAndSort" } }, "totalCount": { "type": "integer", "format": "int64" } } }, "FilteredClientPayloadListPaymentResponse": { "type": "object", "properties": { "apiCall": { "$ref": "#/components/schemas/ApiCall" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentResponse" } }, "nextCursorHash": { "type": "string" }, "nextLink": { "type": "string" }, "pagingMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FilterAndSort" } }, "totalCount": { "type": "integer", "format": "int64" } } }, "FilteredClientPayloadListTransaction": { "type": "object", "properties": { "apiCall": { "$ref": "#/components/schemas/ApiCall" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } }, "nextCursorHash": { "type": "string" }, "nextLink": { "type": "string" }, "pagingMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FilterAndSort" } }, "totalCount": { "type": "integer", "format": "int64" } } }, "FrequencyEnumExtended": { "type": "string", "description": "__Mandatory__. See [payment frequency](/guides/payments/payment-execution/periodic-payments/#payment-frequency) for more information", "enum": [ "DAILY", "EVERY_WORKING_DAY", "CALENDAR_DAY", "WEEKLY", "EVERY_TWO_WEEKS", "MONTHLY", "EVERY_TWO_MONTHS", "QUARTERLY", "SEMIANNUAL", "ANNUAL" ] }, "FrequencyRequest": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FrequencyEnumExtended" }, "intervalWeek": { "type": "integer", "description": "__Conditional__. See [payment frequency](/guides/payments/payment-execution/periodic-payments/#payment-frequency) for more information", "format": "int32", "example": 1 }, "intervalMonth": { "type": "integer", "description": "__Conditional__. See [payment frequency](/guides/payments/payment-execution/periodic-payments/#payment-frequency) for more information", "format": "int32", "example": 1 }, "executionDay": { "type": "integer", "description": "__Conditional__. See [payment frequency](/guides/payments/payment-execution/periodic-payments/#payment-frequency) for more information", "format": "int32", "example": 1 } }, "description": "__Mandatory__. Defines the intervals at which payment should be made." }, "FrequencyResponse": { "type": "object", "description": "__Mandatory__. Defines the intervals at which payment should be made.", "properties": { "frequencyType": { "$ref": "#/components/schemas/FrequencyEnumExtended" }, "intervalWeek": { "type": "integer", "description": "The weekly intervals at which a payment will be made. e.g. 1 = Every months, 2 = Every 2 months.", "format": "int32" }, "intervalMonth": { "type": "integer", "description": "The monthly intervals at which a payment will be made. e.g. 1 = Every month, 2 = Every 2 months", "format": "int32" }, "executionDay": { "type": "integer", "description": "The day on which a payment will be made, according to the weekly or monthly interval.", "format": "int32" } } }, "Identity": { "type": "object", "description": "Identification details of a party associated with an account e.g. (account owner or operator).", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "gender": { "type": "string" }, "birthdate": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityAddress" } } } }, "IdentityAddress": { "type": "object", "properties": { "addressLines": { "type": "array", "items": { "type": "string" } }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "streetName": { "type": "string" }, "buildingNumber": { "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "county": { "type": "string" } } }, "ApiResponseOfIdentity": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/Identity" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "Institution": { "type": "object", "description": "Typically, a bank or business unit within a bank e.g. (AIB Business, AIB Ireland, AIB UK).", "properties": { "id": { "type": "string", "description": "Unique identifier for the `Institution`." }, "name": { "type": "string", "description": "The friendly name of the `Institution`." }, "fullName": { "type": "string", "description": "The full name of the `Institution`." }, "countries": { "uniqueItems": true, "type": "array", "description": "An array of `Country` denoting which regions the `Institution` provides coverage for", "items": { "$ref": "#/components/schemas/Country" } }, "environmentType": { "$ref": "#/components/schemas/EnvironmentType" }, "credentialsType": { "$ref": "#/components/schemas/CredentialsType" }, "media": { "uniqueItems": true, "type": "array", "description": "Contains links to the logo and the icons for the `Institution`", "items": { "$ref": "#/components/schemas/Media" } }, "features": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FeatureEnum" } } } }, "ApiListResponseOfInstitution": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Institution" } }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "paging": { "$ref": "#/components/schemas/FilteredClientPayloadListInstitution" }, "tracingId": { "type": "string", "writeOnly": true } } }, "InstitutionConsent": { "type": "object", "description": "`Institution` authorised consents which are currently in place for the `Application User`.", "properties": { "institutionId": { "type": "string", "description": "__Mandatory__. The `Institution` the authorisation request is sent to." } } }, "InstitutionError": { "type": "object", "description": "Raw error details provided by the `Institution`, when it was the error source.", "properties": { "errorMessage": { "type": "string", "description": "Textual description of the `Institution` error." }, "httpStatusCode": { "type": "integer", "description": "Numeric HTTP status code associated with the `Institution` error.", "format": "int32" } } }, "InternationalPaymentRequest": { "required": [ "currencyOfTransfer" ], "type": "object", "properties": { "currencyOfTransfer": { "type": "string", "description": "__Mandatory__. The currency to be transferred to the payee. This may differ from the currency the payment is denoted in and the currency of the payer's account. Specified as a 3-letter code (ISO 4217)." }, "exchangeRateInformation": { "$ref": "#/components/schemas/ExchangeRateInformation" }, "purpose": { "type": "string", "description": "__Optional__. Used to indicate the external purpose as a [ISO20022 purpose code](https://www.rba.hr/documents/20182/183267/External+purpose+codes+list/8a28f888-1f83-5e29-d6ed-fce05f428689?version=1.1) value." }, "priority": { "$ref": "#/components/schemas/PriorityCodeEnum" }, "chargeBearer": { "$ref": "#/components/schemas/ChargeBearerType" } }, "description": "__Conditional__. Used to specify properties to define an international payment.

Must be specified when the payment `type` is one of the following:" }, "IsoBankTransactionCode": { "type": "object", "description": "Defines the underlying transaction type (e.g. Card or Debit Transactions, Loans or Mortages).

Conforms to `ISO` standards - ISO 20022.", "properties": { "domainCode": { "$ref": "#/components/schemas/IsoCodeDetails" }, "familyCode": { "$ref": "#/components/schemas/IsoCodeDetails" }, "subFamilyCode": { "$ref": "#/components/schemas/IsoCodeDetails" } } }, "IsoCodeDetails": { "type": "object", "description": "__Mandatory__. Details the identification of the ISO code.", "properties": { "code": { "default": "UNKNOWN", "description": "__Mandatory__. Unique identifier of the ISO code.", "type": "string" }, "name": { "default": "UNKNOWN", "description": "__Mandatory__. Name of the ISO Code.", "type": "string" } } }, "Media": { "type": "object", "properties": { "source": { "type": "string", "description": "__Mandatory__. URL from where the media can be retrieved." }, "type": { "type": "string", "description": "__Mandatory__. The type of media e.g. (logo, icon)." } }, "description": "Details of the media held for the `Institution`" }, "Merchant": { "type": "object", "description": "Details of the merchant involved in the transaction.", "properties": { "merchantName": { "type": "string", "description": "The name of the merchant involved in the transaction." }, "merchantCategoryCode": { "type": "string", "format": "^\\d{4}$", "description": "Defines the underlying services and goods that the merchant provides. Specified as a 4-letter ISO 18245 code.

Allowed values:" } } }, "MultiAuthorisation": { "type": "object", "description": "Details the additional levels of authorisation which are required from, and being managed by, the `Institution`.", "properties": { "status": { "type": "string", "description": "__Mandatory__. Specifies the current status of the multi-authorisation flow." }, "numberOfAuthorisationRequired": { "type": "integer", "description": "__Mandatory__. Total number of authorisations required.", "format": "int32" }, "numberOfAuthorisationReceived": { "type": "integer", "description": "__Mandatory__. The total number of authorisations that have been received.", "format": "int32" }, "lastUpdatedDateTime": { "type": "string", "description": "__Mandatory__. Date and time of when the authorisation was last updated.", "format": "date-time" }, "expirationDateTime": { "type": "string", "description": "__Mandatory__. Date and time by when the authorisation flow must be completed before it expires and the authorisation request is terminated.", "format": "date-time" } } }, "NewApplicationUser": { "type": "object", "description": "Details of a new user to be created for the application.", "properties": { "applicationUserId": { "type": "string", "description": "__Optional__. The unique identifier of the `Application User` assigned by the Application Owner.", "example": "user-234562290" }, "referenceId": { "type": "string", "description": "__Deprecated__. A non-unique reference Id for the `Application User`." }, "vopOptOut": { "type": "boolean", "description": "__Optional__. A flag to indicate whether the user has opted out of VOP.", "default": false } } }, "Next": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "before": { "type": "string", "format": "date-time" }, "limit": { "type": "integer", "format": "int32" }, "cursor": { "type": "string" } } }, "OneTimeTokenRequest": { "required": [ "oneTimeToken" ], "type": "object", "properties": { "oneTimeToken": { "type": "string", "description": "__Mandatory__. The one time token to exchange for a consent token.", "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6ImJidmEtc2FuZGJveCIsIlVVSUQiOiJmMzNmNGU4ZC1jMDQ0LTQ2YTktOTlkMC0wYmRlMzIyYTJjOTIifQ.4Qv3NJI6av2nKi1U3aNmm71cIwJ3TvRsIlYDafQUVv_Khy_e-8oEpV_BoP4V1CII12oT-Yq4cPveHILz8BOwjg" } }, "description": "The request body containing the `OneTimeTokenRequest` json payload" }, "Pagination": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "self": { "$ref": "#/components/schemas/FilterAndSort" }, "next": { "$ref": "#/components/schemas/Next" } } }, "Payee": { "title": "Payee Details", "type": "object", "description": "__Mandatory__. Details of the beneficiary [person or business].", "required": [ "accountIdentifications", "name" ], "properties": { "name": { "title": "Payee Name", "type": "string", "description": "__Mandatory__. The account holder name of the beneficiary.", "example": "Jane Doe" }, "accountIdentifications": { "uniqueItems": true, "type": "array", "description": "__Mandatory__. The account identifications that identify the `Payee` bank account.", "example": [ { "identification": "401016", "type": "SORT_CODE" }, { "identification": "71518920", "type": "ACCOUNT_NUMBER" } ], "items": { "$ref": "#/components/schemas/AccountIdentification" } }, "accountType": { "$ref": "#/components/schemas/PayeeAccountType" }, "address": { "$ref": "#/components/schemas/Address" }, "merchantId": { "title": "Merchant Id", "type": "string", "description": "__Optional__. The merchant ID is a unique code provided by the payment processor to the merchant.", "example": "24589303" }, "merchantCategoryCode": { "title": "Merchant Category", "type": "string", "format": "^\\d{4}$", "description": "__Optional__. The category code of the merchant in case the `Payee` is a business. Specified as a 4-letter ISO 18245 code.

Allowed values:", "example": "0742" } } }, "PayeeDetailsResponse": { "title": "Payee Details", "type": "object", "description": " Details of the beneficiary [person or business].", "properties": { "name": { "title": "Payee Name", "type": "string", "description": "The account holder name of the beneficiary.", "example": "Jane Doe" }, "accountIdentifications": { "uniqueItems": true, "type": "array", "description": "The account identifications that identify the `Payee` bank account.", "example": [ { "identification": "401016", "type": "SORT_CODE" }, { "identification": "71518920", "type": "ACCOUNT_NUMBER" } ], "items": { "$ref": "#/components/schemas/AccountIdentificationResponse" } }, "address": { "$ref": "#/components/schemas/AddressResponse" }, "merchantId": { "title": "Merchant Id", "type": "string", "description": "The merchant ID is a unique code provided by the payment processor to the merchant.", "example": "24589303" }, "merchantCategoryCode": { "title": "Merchant Category", "type": "string", "description": "The category code of the merchant in case the `Payee` is a business. Specified as a 3-letter ISO 18245 code.", "example": "5551" } } }, "PayeeDetails": { "type": "object", "required": [ "accountIdentifications", "name", "country" ], "properties": { "name": { "type": "string", "description": "__Mandatory__. The account holder name of the beneficiary.", "example": "Jane Doe" }, "accountIdentifications": { "uniqueItems": true, "type": "array", "description": "__Mandatory__. The account identifications that identify the `Payee` bank account.", "example": [ { "identification": "IBUK123456789", "type": "IBAN" } ], "items": { "$ref": "#/components/schemas/AccountIdentification" } }, "country": { "type": "string", "deprecated": true, "description": "__Deprecated__. Use `address.country` instead. The 2-letter ISO 3166 country code for the address.

An `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment. This field will be removed in a future version - please use the `country` field within the `address` object.", "example": "GB" }, "address": { "$ref": "#/components/schemas/Address" } }, "description": "__Mandatory__. Details of the beneficiary [person or business]." }, "Payer": { "title": "Payer Details", "required": [ "accountIdentifications" ], "type": "object", "properties": { "name": { "title": "Payer Name", "type": "string", "description": "The account holder name of the Payer.", "example": "John Doe" }, "accountIdentifications": { "uniqueItems": true, "type": "array", "description": "__Mandatory__. The account identifications that identify the `Payer` bank account.", "items": { "$ref": "#/components/schemas/AccountIdentification" } }, "address": { "$ref": "#/components/schemas/Address" } }, "description": "__Conditional__. Details of the benefactor [person or business]." }, "HostedVrpPayerResponse": { "title": "Payer Details", "required": [ "accountIdentifications" ], "type": "object", "properties": { "name": { "title": "Payer Name", "type": "string", "description": "The account holder name of the Payer.", "example": "John Doe" }, "accountIdentifications": { "uniqueItems": true, "type": "array", "description": "__Mandatory__. The account identifications that identify the `Payer` bank account.", "items": { "$ref": "#/components/schemas/HostedVrpAccountIdentification" } }, "address": { "$ref": "#/components/schemas/Address" } }, "description": "__Conditional__. Details of the benefactor [person or business]." }, "PayerDetailsResponse": { "title": "Payer Details", "type": "object", "properties": { "name": { "title": "Payer Name", "type": "string", "description": "The account holder name of the Payer.", "example": "John Doe" }, "accountIdentifications": { "uniqueItems": true, "type": "array", "description": "The account identifications that identify the `Payer` bank account.", "items": { "$ref": "#/components/schemas/AccountIdentificationResponse" } }, "address": { "$ref": "#/components/schemas/AddressResponse" } }, "description": "Details of the benefactor [person or business]." }, "PayerDetails": { "required": [ "accountIdentifications" ], "type": "object", "properties": { "accountIdentifications": { "uniqueItems": true, "type": "array", "description": "__Mandatory__. The account identifications that identify the `Payer` bank account.", "items": { "$ref": "#/components/schemas/AccountIdentification" } } }, "description": "__Conditional__. Details of the benefactor [person or business]." }, "PaymentAuthorisationRequest": { "required": [ "institutionId", "paymentRequest" ], "type": "object", "properties": { "userUuid": { "type": "string", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "__Conditional__. The user-friendly reference to the `User` that will authorise the authorisation request. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided.", "example": "user-234562290" }, "forwardParameters": { "type": "array", "description": "Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect.", "items": { "type": "string" } }, "institutionId": { "type": "string", "description": "__Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to.", "example": "yapily-mock" }, "callback": { "type": "string", "description": "__Optional__. The URL to redirect the user to after the user complete the authorisation at the `Institution`.", "example": "https://display-parameters.com" }, "redirect": { "$ref": "#/components/schemas/RedirectRequest" }, "oneTimeToken": { "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.

See [Using a callback with an OTT (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-with-an-ott-optional) for more information.", "example": false }, "paymentRequest": { "$ref": "#/components/schemas/PaymentRequest" } }, "description": "The request body containing an `PaymentAuthorisationRequest` json payload" }, "PaymentAuthorisationRequestResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the payment authorisation request.

The `consentID` used to [retrieve a consent](/api/reference/#operation/getConsentById).", "format": "uuid" }, "userUuid": { "type": "string", "description": "The `User` that the authorisation request was created for.", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "The user-friendly reference to the `User` that the authorisation request was created for." }, "referenceId": { "type": "string" }, "institutionId": { "type": "string", "description": "The `Institution` the authorisation request was sent to." }, "status": { "$ref": "#/components/schemas/AuthorisationStatus" }, "createdAt": { "type": "string", "description": "Date and time the consent was created.", "format": "date-time" }, "transactionFrom": { "type": "string", "description": "When performing a transaction query using the consent, this is the earliest date of transaction records that can be retrieved.", "format": "date-time" }, "transactionTo": { "type": "string", "description": "When performing a transaction query using the consent, this is the latest date of transaction records that can be retrieved.", "format": "date-time" }, "expiresAt": { "type": "string", "description": "Date and time the authorisation expires. Re-authorisation is needed to retain access.", "format": "date-time" }, "timeToExpireInMillis": { "type": "integer", "format": "int64", "deprecated": true }, "timeToExpire": { "type": "string", "format": "iso8601" }, "featureScope": { "uniqueItems": true, "description": "The set of features the consent provides access to.", "type": "array", "items": { "$ref": "#/components/schemas/FeatureEnum" } }, "consentToken": { "type": "string", "description": "Represents the authorisation to gain access to the requested features. Required to make a payment request." }, "state": { "type": "string", "description": "Correlation ID used with the `Institution` during the authorisation process." }, "authorizedAt": { "type": "string", "description": "Date and time the request was authorised by the `Institution`.", "format": "date-time" }, "institutionConsentId": { "type": "string", "description": "Unique identifier of the consent assigned by the `Institution`." }, "charges": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentChargeDetails" } }, "exchangeRateInformation": { "$ref": "#/components/schemas/ExchangeRateInformationResponse" }, "authorisationUrl": { "type": "string" }, "qrCodeUrl": { "type": "string", "description": "The URL for a QR code that may be scanned via a mobile device to make a authorisation redirect to the bank (authURL encoded)." }, "explanation": { "type": "string", "description": "Message from the `Institution` received by Yapily, detailing the next action the user is required to take. This is used only for Decoupled flows." } } }, "ApiResponseOfPaymentAuthorisationRequestResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/PaymentAuthorisationRequestResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "PaymentContextType": { "title": "Payment Code", "type": "string", "default": "OTHER", "description": "__Optional__. The payment context code. This defaults to `OTHER` if not specified.", "enum": [ "BILL", "GOODS", "SERVICES", "OTHER", "PERSON_TO_PERSON", "BILL_IN_ADVANCE", "BILL_IN_ARREARS", "ECOMMERCE_MERCHANT", "FACE_TO_FACE_POS", "TRANSFER_TO_SELF", "TRANSFER_TO_THIRD_PARTY", "PISP_PAYEE" ] }, "PaymentPurposeCode": { "title": "Payment Purpose Code", "type": "string", "description": "__Optional__. The payment purpose code.

Allowed values: INTP, DEPT, BEXP, LICF, SERV, SUPP, TRAD, SUBS, GDSV, ROYA, COMT, CHAR, ECPR, CLPR, INTE, LOAN, LOAR, INPC, INPR, INSC, INSU, LIFI, PPTI, HLRP, HLST, PDEP, IVPT, REBT, REFU, CDBL, CPKC, EDUC, FEES, GAMB, LOTT, GIFT, INSM, REOD, GOVT, TCSC, BLDM, RENT, DIVD, INVS, SAVG, HLTI, DNTS, LTCF, MDCS, VIEW, BECH, BENE, SSBE, PEFC, PENS, ADCS, BONU, COMM, SALA, ESTX, HSTX, INTX, PTXP, RDTX, TAXS, VATX, WHLD, TAXR, CBTV, ELEC, GASB, PHON, UBIL, WTER .

See [Payment Purpose code](https://docs.yapily.com/pages/payments/payments-resources/tri-pilot/) to see the definition of each code" }, "PayeeAccountType": { "title": "Payee Account Type", "type": "string", "description": "__Optional__. The payee account type.

Allowed values: BUSINESS, BUSINESS_SAVING, CHARITY, COLLECTION, CORPORATE, E_WALLET, GOVERNMENT, INVESTMENT, INVESTMENT_ISA, JOINT_PERSONAL, PENSION, PERSONAL, PERSONAL_SAVING, PREMIER, WEALTH ." }, "PaymentContextTypeV2": { "title": "Payment Code", "type": "string", "description": "__Optional__. The payment context code. Allowed values are [BILL_IN_ADVANCE, BILL_IN_ARREARS, ECOMMERCE_MERCHANT, FACE_TO_FACE_POS, TRANSFER_TO_SELF,TRANSFER_TO_THIRD_PARTY, PISP_PAYEE ]." }, "PaymentContextTypeV2Response": { "title": "Payment Code", "type": "string", "default": "OTHER", "description": "The payment context code. Allowed values are [BILL_IN_ADVANCE, BILL_IN_ARREARS, ECOMMERCE_MERCHANT, FACE_TO_FACE_POS, TRANSFER_TO_SELF,TRANSFER_TO_THIRD_PARTY, PISP_PAYEE ]." }, "PaymentContextTypeResponse": { "title": "Payment Code", "type": "string", "description": "The payment context code.", "enum": [ "BILL", "GOODS", "SERVICES", "OTHER", "PERSON_TO_PERSON" ] }, "PaymentEmbeddedAuthorisationRequest": { "required": [ "institutionId", "paymentRequest" ], "type": "object", "properties": { "userUuid": { "type": "string", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "__Conditional__. The user-friendly reference to the `User` that will authorise the authorisation request. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided.", "example": "user-234562290" }, "institutionId": { "type": "string", "description": "__Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to.", "example": "yapily-mock" }, "callback": { "type": "string", "description": "__Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`.

See [Using a callback (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-optional) for more information.", "example": "https://display-parameters.com" }, "redirect": { "$ref": "#/components/schemas/RedirectRequest" }, "oneTimeToken": { "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.

See [Using a callback with an OTT (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-with-an-ott-optional) for more information.", "example": false }, "paymentRequest": { "$ref": "#/components/schemas/PaymentRequest" }, "userCredentials": { "$ref": "#/components/schemas/UserCredentials" }, "selectedScaMethod": { "$ref": "#/components/schemas/ScaMethod" }, "scaCode": { "type": "string", "description": "__Conditional__. Used to update the authorisation with the sca code received by the user from the `Institution` using the embedded payment authorisation flow.

This is the penultimate step required in the embedded payment authorisation flow to authorise the `Consent`. After sending the sca code, to obtain an authorised consent, the last step is to poll [Get Consent](https://docs.yapily.com/api/reference/#operation/getConsentById) until the `Institution` authorises the request and the `Consent` `status` transitions to `AUTHORIZED`.", "example": "325614" } }, "description": "The request body containing an `PaymentEmbeddedAuthorisationRequest` json payload" }, "PaymentEmbeddedAuthorisationRequestResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the embedded payment authorisation request.", "format": "uuid" }, "userUuid": { "type": "string", "description": "The `User` that the authorisation request was created for.", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "The user-friendly reference to the `User` that the authorisation request was created for." }, "referenceId": { "type": "string" }, "institutionId": { "type": "string", "description": "The `Institution` the authorisation request was sent to." }, "status": { "$ref": "#/components/schemas/AuthorisationStatus" }, "createdAt": { "type": "string", "description": "Date and time the embedded payment authorisation was created.", "format": "date-time" }, "transactionFrom": { "type": "string", "description": "When performing a transaction query using the consent, this is the earliest date of transaction records that can be retrieved.", "format": "date-time" }, "transactionTo": { "type": "string", "description": "When performing a transaction query using the consent, this is the latest date of transaction records that can be retrieved.", "format": "date-time" }, "expiresAt": { "type": "string", "description": "Date and time the authorisation expires. Re-authorisation is needed to retain access.", "format": "date-time" }, "timeToExpireInMillis": { "type": "integer", "format": "int64", "deprecated": true }, "timeToExpire": { "type": "string", "format": "iso8601" }, "featureScope": { "uniqueItems": true, "description": "The set of features the consent provides access to.", "type": "array", "items": { "$ref": "#/components/schemas/FeatureEnum" } }, "consentToken": { "type": "string", "description": "Represents the authorisation to gain access to the requested features. Required to make a payment request." }, "state": { "type": "string", "description": "Correlation ID used with the `Institution` during the authorisation process." }, "authorizedAt": { "type": "string", "description": "Date and time the request was authorised by the `Institution`.", "format": "date-time" }, "institutionConsentId": { "type": "string", "description": "Identification of the consent at the `Institution`." }, "charges": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentChargeDetails" } }, "exchangeRateInformation": { "$ref": "#/components/schemas/ExchangeRateInformationResponse" }, "authorisationUrl": { "type": "string" }, "qrCodeUrl": { "type": "string", "description": "The URL link for the QR code that may be scanned via a mobile device to make an authorisation redirect to the bank (authURL encoded)." }, "explanation": { "type": "string" }, "scaMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ScaMethod" } }, "selectedScaMethod": { "$ref": "#/components/schemas/ScaMethod" } } }, "ApiResponseOfPaymentEmbeddedAuthorisationRequestResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/PaymentEmbeddedAuthorisationRequestResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "PaymentIsoStatus": { "type": "object", "description": "The payment status code, as denoted by a 3-letter ISO 20022 code.", "properties": { "code": { "$ref": "#/components/schemas/PaymentIsoStatusCodeEnum" }, "name": { "type": "string", "description": "The full name of the ISO 20022 `PaymentStatusCode`.", "example": "AcceptedCreditSettlementCompleted" } } }, "PaymentIsoStatusCodeEnum": { "type": "string", "description": "The ISO 20022 `PaymentStatusCode`.", "example": "ACCC", "enum": [ "ACCC", "ACCP", "ACSC", "ACSP", "ACTC", "ACWC", "ACWP", "RCVD", "PDNG", "RJCT", "CANC", "ACFC", "PATC", "PART", "ACCO" ] }, "PaymentPreAuthorisationRequest": { "required": [ "institutionId", "scope", "payee", "payer", "amount", "reference" ], "type": "object", "properties": { "userUuid": { "type": "string", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "__Conditional__. The user-friendly reference to the `User` that will authorise the authorisation request. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided.", "example": "user-234562290" }, "forwardParameters": { "type": "array", "description": "Extra parameters to be forwarded in the redirect back to the client after the user authorisation flow has been completed.", "items": { "type": "string" } }, "institutionId": { "type": "string", "description": "__Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to.", "example": "yapily-mock" }, "callback": { "type": "string", "description": "__Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`.

See [Using a callback (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-optional) for more information.", "example": "https://display-parameters.com" }, "redirect": { "$ref": "#/components/schemas/RedirectRequest" }, "oneTimeToken": { "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.

See [Using a callback with an OTT (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-with-an-ott-optional) for more information.", "example": false }, "scope": { "type": "string", "description": "__Mandatory__. Defines the scope of the pre-authorisation request.", "example": "AIS" }, "payee": { "$ref": "#/components/schemas/PayeeDetails" }, "payer": { "$ref": "#/components/schemas/PayerDetails" }, "amount": { "$ref": "#/components/schemas/Amount" }, "reference": { "type": "string", "description": "__Mandatory__. The payment reference or description. Limited to a maximum of 18 characters long.", "example": "Bill payment" } }, "description": "__Mandatory__. The payment pre authorisation request object defining the details of the payment and pre auth." }, "PaymentRequest": { "required": [ "amount", "payee", "paymentIdempotencyId", "type" ], "type": "object", "properties": { "paymentIdempotencyId": { "title": "Idempotency Id", "type": "string", "description": "__Mandatory__. A unique identifier that you must provide to identify the payment. This can be any alpha-numeric string but is limited to a maximum of 35 characters.", "example": "04ab4536gaerfc0e1f93c4f4" }, "payer": { "$ref": "#/components/schemas/Payer" }, "reference": { "title": "Payment Reference", "type": "string", "description": "__Optional__. The payment reference or description. Limited to a maximum of 18 characters long.", "example": "Bill payment" }, "contextType": { "$ref": "#/components/schemas/PaymentContextType" }, "purposeCode": { "$ref": "#/components/schemas/PaymentPurposeCode" }, "type": { "$ref": "#/components/schemas/PaymentType" }, "payee": { "$ref": "#/components/schemas/Payee" }, "periodicPayment": { "$ref": "#/components/schemas/PeriodicPaymentRequest" }, "internationalPayment": { "$ref": "#/components/schemas/InternationalPaymentRequest" }, "amount": { "$ref": "#/components/schemas/Amount" }, "paymentDateTime": { "title": "Payment Date", "type": "string", "description": "__Conditional__. Used to specify the date of the payment when the payment type is one of the following:", "format": "date-time", "example": "2021-07-21T17:32:28Z" }, "readRefundAccount": { "title": "Read Refund Account", "type": "boolean", "description": "__Optional__. Used to request the payer details in the payment response when the `Institution` provides the feature `READ_DOMESTIC_SINGLE_REFUND`.

See [Reverse Payments](https://docs.yapily.com/pages/knowledge/open-banking/reverse_payments/) for more information.", "example": false } }, "description": "__Mandatory__. The payment request object defining the details of the payment." }, "PaymentResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the payment." }, "institutionConsentId": { "type": "string", "description": "Identification of the consent at the Institution." }, "paymentIdempotencyId": { "type": "string", "description": "__Mandatory__. A unique identifier that you must provide to identify the payment. This can be any alpha-numeric string but is limited to a maximum of 35 characters." }, "paymentLifecycleId": { "type": "string" }, "status": { "$ref": "#/components/schemas/PaymentStatus" }, "statusDetails": { "$ref": "#/components/schemas/PaymentStatusDetails" }, "payer": { "$ref": "#/components/schemas/Payer" }, "payeeDetails": { "$ref": "#/components/schemas/Payee" }, "reference": { "type": "string", "description": "__Optional__. The payment reference or description. Limited to a maximum of 18 characters long." }, "amount": { "type": "number", "description": "Monetary amount." }, "currency": { "type": "string", "description": "Currency the payment amount is denoted in. Specified as a 3-letter ISO 4217 code." }, "amountDetails": { "$ref": "#/components/schemas/Amount" }, "createdAt": { "type": "string", "description": "Date and time of when the payment request was created.", "format": "date-time" }, "firstPaymentAmount": { "$ref": "#/components/schemas/Amount" }, "firstPaymentDateTime": { "type": "string", "description": "Date and time of when the first payment request is to be made.", "format": "date-time" }, "nextPaymentAmount": { "$ref": "#/components/schemas/Amount" }, "nextPaymentDateTime": { "type": "string", "description": "__Conditional__. Defines when the recurring payment is to be made.", "format": "date-time" }, "finalPaymentAmount": { "$ref": "#/components/schemas/Amount" }, "finalPaymentDateTime": { "type": "string", "description": "Date and time of when the final payment is to be made.", "format": "date-time" }, "numberOfPayments": { "type": "integer", "description": "Number of recurring payment requests to be made as part of the instructed payment schedule.", "format": "int32" }, "previousPaymentAmount": { "$ref": "#/components/schemas/Amount" }, "previousPaymentDateTime": { "type": "string", "description": "Date and time of when the previous payment request was posted.", "format": "date-time" }, "chargeDetails": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentChargeDetails" } }, "scheduledPaymentType": { "type": "string", "description": "Details the execution type and the payment date between the payer and the payee." }, "scheduledPaymentDateTime": { "type": "string", "description": "Date and time of when the scheduled payment request will be made.", "format": "date-time" }, "frequency": { "$ref": "#/components/schemas/FrequencyResponse" }, "currencyOfTransfer": { "type": "string", "description": "__Mandatory__. The currency to be transferred to the payee. This may differ from the currency the payment is denoted in and the currency of the payer's account. Specified as a 3-letter code (ISO 4217)." }, "purpose": { "type": "string", "description": "Specifies the external purpose code for the `Institution` - IS0 20022." }, "priority": { "$ref": "#/components/schemas/PriorityCodeEnum" }, "exchangeRate": { "$ref": "#/components/schemas/ExchangeRateInformationResponse" }, "refundAccount": { "$ref": "#/components/schemas/RefundAccount" }, "bulkAmountSum": { "type": "number" } } }, "ApiListResponseOfPaymentResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentResponse" } }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "paging": { "$ref": "#/components/schemas/FilteredClientPayloadListPaymentResponse" }, "tracingId": { "type": "string", "writeOnly": true } } }, "ApiResponseOfPaymentResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/PaymentResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "PaymentResponses": { "type": "object", "properties": { "payments": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentResponse" } } } }, "ApiResponseOfPaymentResponses": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/PaymentResponses" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "PaymentStatus": { "type": "string", "description": "The status of the Payment.

For more information, see [Payment Status](/guides/payments/payment-status/)", "enum": [ "PENDING", "FAILED", "DECLINED", "COMPLETED", "COMPLETED_SETTLEMENT_IN_PROCESS", "EXPIRED", "UNKNOWN", "ACTIVE", "INACTIVE" ] }, "PaymentStatusDetails": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/PaymentStatus" }, "statusReason": { "type": "string" }, "statusReasonDescription": { "type": "string" }, "statusUpdateDate": { "type": "string", "format": "date-time" }, "multiAuthorisationStatus": { "$ref": "#/components/schemas/MultiAuthorisation" }, "isoStatus": { "$ref": "#/components/schemas/PaymentIsoStatus" } } }, "PaymentType": { "title": "Payment Type", "type": "string", "description": "__Mandatory__. Used to specify which of the [payment types](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/intro-to-payment-execution/#payment-types) to execute.

See [European Payments](https://docs.yapily.com/pages/knowledge/open-banking/european_payments/) to verify whether the `type` should be `DOMESTIC` or `INTERNATIONAL`.", "enum": [ "DOMESTIC_PAYMENT", "DOMESTIC_INSTANT_PAYMENT", "DOMESTIC_VARIABLE_RECURRING_PAYMENT", "DOMESTIC_SCHEDULED_PAYMENT", "DOMESTIC_PERIODIC_PAYMENT", "INTERNATIONAL_PAYMENT", "INTERNATIONAL_SCHEDULED_PAYMENT", "INTERNATIONAL_PERIODIC_PAYMENT", "BULK_PAYMENT" ] }, "PaymentTypeResponse": { "title": "Payment Type", "type": "string", "description": "Specifies which of the [payment types](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/intro-to-payment-execution/#payment-types) to execute.
", "enum": [ "DOMESTIC_PAYMENT", "DOMESTIC_INSTANT_PAYMENT", "DOMESTIC_VARIABLE_RECURRING_PAYMENT", "DOMESTIC_SCHEDULED_PAYMENT", "DOMESTIC_PERIODIC_PAYMENT", "INTERNATIONAL_PAYMENT", "INTERNATIONAL_SCHEDULED_PAYMENT", "INTERNATIONAL_PERIODIC_PAYMENT" ] }, "PaymentTypeOfConstraints": { "title": "Payment Type", "type": "string", "description": "Payment type associated with constraints.", "enum": [ "DOMESTIC_PAYMENT", "DOMESTIC_INSTANT_PAYMENT", "DOMESTIC_VARIABLE_RECURRING_PAYMENT", "DOMESTIC_SCHEDULED_PAYMENT", "DOMESTIC_PERIODIC_PAYMENT", "INTERNATIONAL_PAYMENT", "INTERNATIONAL_SCHEDULED_PAYMENT", "INTERNATIONAL_PERIODIC_PAYMENT" ] }, "PeriodicPaymentRequest": { "required": [ "frequency" ], "type": "object", "properties": { "frequency": { "$ref": "#/components/schemas/FrequencyRequest" }, "numberOfPayments": { "type": "integer", "description": "__Conditional__. Defines the total number of payments to be made.

This is required if `finalPaymentDateTime` is not specified and it is intended for the periodic payment have a fixed amount of payments.", "format": "int32", "example": 5 }, "nextPaymentDateTime": { "type": "string", "description": "__Conditional__. Defines when to start the recurring payment date and time. Specify this if you want the first payment to start on a different day than what the frequency object defines.", "format": "date-time", "example": "2018-01-10T00:00:00Z" }, "nextPaymentAmount": { "$ref": "#/components/schemas/Amount" }, "finalPaymentDateTime": { "type": "string", "description": "__Conditional__. Defines the final payment date and time. To create an open-ended periodic payment, do not specify this property.", "format": "date-time", "example": "2030-01-10T00:00:00Z" }, "finalPaymentAmount": { "$ref": "#/components/schemas/Amount" } }, "description": "__Conditional__. Used to specify properties to define a periodic payment.

Must be specified when the payment `type` is one of the following:" }, "BulkPaymentResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID for this Bulk Payment." }, "institutionConsentId": { "type": "string", "description": "The Institution's Consent ID used for this Bulk Payment." }, "institutionInteractionId": { "type": "string", "description": "The Financial API (FAPI) Interaction ID for this Bulk Payment." }, "paymentIdempotencyId": { "type": "string", "description": "The unique ID provided by you to identify this Bulk Payment." }, "paymentLifecycleId": { "type": "string" }, "paymentScheme": { "type": "string", "description": "The payment scheme (ie. payment rail, local instrument) used to carry out this Bulk Payment." }, "status": { "$ref": "#/components/schemas/PaymentStatus" }, "statusDetails": { "$ref": "#/components/schemas/BulkPaymentStatusDetails" }, "payer": { "$ref": "#/components/schemas/Payer" }, "payeeDetails": { "$ref": "#/components/schemas/Payee" }, "reference": { "type": "string", "description": "The reference or description for this Bulk Payment." }, "amount": { "type": "number", "description": "The total monetary amount of this Bulk Payment." }, "currency": { "type": "string", "description": "The currency of the amount, specified as a 3-letter ISO 4217 code." }, "amountDetails": { "$ref": "#/components/schemas/Amount" }, "createdAt": { "type": "string", "description": "Date and time of when the payment request was created.", "format": "date-time" }, "firstPaymentAmount": { "$ref": "#/components/schemas/Amount" }, "firstPaymentDateTime": { "type": "string", "description": "Date and time of when the first payment request is to be made.", "format": "date-time" }, "nextPaymentAmount": { "$ref": "#/components/schemas/Amount" }, "nextPaymentDateTime": { "type": "string", "description": "__Conditional__. Defines when the recurring payment is to be made.", "format": "date-time" }, "finalPaymentAmount": { "$ref": "#/components/schemas/Amount" }, "finalPaymentDateTime": { "type": "string", "description": "Date and time of when the final payment is to be made.", "format": "date-time" }, "numberOfPayments": { "type": "integer", "description": "Number of recurring payment requests to be made as part of the instructed payment schedule.", "format": "int32" }, "previousPaymentAmount": { "$ref": "#/components/schemas/Amount" }, "previousPaymentDateTime": { "type": "string", "description": "Date and time of when the previous payment request was posted.", "format": "date-time" }, "chargeDetails": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentChargeDetails" } }, "scheduledPaymentType": { "type": "string", "description": "Details the execution type and the payment date between the payer and the payee." }, "scheduledPaymentDateTime": { "type": "string", "description": "Date and time of when the scheduled payment request will be made.", "format": "date-time" }, "frequency": { "$ref": "#/components/schemas/FrequencyResponse" }, "currencyOfTransfer": { "type": "string", "description": "__Mandatory__. The currency to be transferred to the payee. This may differ from the currency the payment is denoted in and the currency of the payer's account. Specified as a 3-letter code (ISO 4217)." }, "purpose": { "type": "string", "description": "Specifies the external purpose code for the `Institution` - IS0 20022." }, "priority": { "$ref": "#/components/schemas/PriorityCodeEnum" }, "exchangeRate": { "$ref": "#/components/schemas/ExchangeRateInformationResponse" }, "refundAccount": { "$ref": "#/components/schemas/RefundAccount" }, "bulkAmountSum": { "type": "number" } } }, "BulkPaymentStatusDetails": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/PaymentStatus" }, "statusReason": { "type": "string" }, "statusReasonDescription": { "type": "string" }, "statusUpdateDate": { "type": "string", "format": "date-time" }, "multiAuthorisationStatus": { "$ref": "#/components/schemas/MultiAuthorisation" }, "isoStatus": { "type": "object", "description": "The Institution's status for this Bulk Payment.", "properties": { "code": { "type": "string", "description": "The Institution's status code for this Bulk Payment. It will often be a 3-letter ISO 20022 status code, but it may also contain other values.", "example": "ACSP" }, "name": { "type": "string", "description": "The full name for the status code, provided only when it is a valid ISO 20022 status code.", "example": "AcceptedSettlementInProcess" } } } } }, "ApiResponseOfCreateBulkPaymentRequest": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/BulkPaymentResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "PreAuthorisationRequest": { "required": [ "institutionId", "scope" ], "type": "object", "properties": { "userUuid": { "type": "string", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "__Conditional__. The user-friendly reference to the `User` that will authorise the authorisation request. If a `User` with the specified `applicationUserId` exists, it will be used otherwise, a new `User` with the specified `applicationUserId` will be created and used. Either the `userUuid` or `applicationUserId` must be provided.", "example": "user-234562290" }, "forwardParameters": { "type": "array", "description": "Extra parameters to be forwarded in the redirect back to the client after the user authorisation flow has been completed.", "items": { "type": "string" } }, "institutionId": { "type": "string", "description": "__Mandatory__. The reference to the `Institution` which identifies which institution the authorisation request is sent to.", "example": "yapily-mock" }, "callback": { "type": "string", "description": "__Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`.

See [Using a callback (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-optional) for more information.", "example": "https://display-parameters.com" }, "redirect": { "$ref": "#/components/schemas/RedirectRequest" }, "oneTimeToken": { "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.

See [Using a callback with an OTT (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-with-an-ott-optional) for more information.", "example": false }, "scope": { "type": "string", "description": "__Mandatory__. Defines the scope of the pre-authorisation request.", "example": "AIS" } } }, "PreAuthorisationResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the pre-authorisation request.", "format": "uuid" }, "userUuid": { "type": "string", "description": "The `User` that the authorisation request was created for.", "format": "uuid" }, "applicationUserId": { "type": "string", "description": "The user-friendly reference to the `User` that the authorisation request was created for." }, "referenceId": { "type": "string" }, "institutionId": { "type": "string", "description": "The `Institution` the authorisation request was sent to." }, "status": { "$ref": "#/components/schemas/AuthorisationStatus" }, "createdAt": { "type": "string", "description": "Date and time the consent was created.", "format": "date-time" }, "transactionFrom": { "type": "string", "description": "When performing a transaction query using the consent, this is the earliest date of transaction records that can be retrieved.", "format": "date-time" }, "transactionTo": { "type": "string", "description": "When performing a transaction query using the consent, this is the latest date of transaction records that can be retrieved.", "format": "date-time" }, "expiresAt": { "type": "string", "description": "Date and time the authorisation expires. Re-authorisation is needed to retain access.", "format": "date-time" }, "timeToExpireInMillis": { "type": "integer", "format": "int64", "deprecated": true }, "timeToExpire": { "type": "string", "format": "iso8601" }, "featureScope": { "uniqueItems": true, "description": "The set of features the consent provides access to.", "type": "array", "items": { "$ref": "#/components/schemas/FeatureEnum" } }, "consentToken": { "type": "string", "description": "Represents the authorisation to gain access to the requested features. Required to access account information or make a payment request." }, "state": { "type": "string", "description": "Correlation ID used with the `Institution` during the authorisation process." }, "authorizedAt": { "type": "string", "description": "Date and time the request was authorised by the `Institution`.", "format": "date-time" }, "institutionConsentId": { "type": "string", "description": "Unique identifier of the consent assigned by the `Institution`." }, "authorisationUrl": { "type": "string" }, "qrCodeUrl": { "type": "string", "description": "The URL link for the QR code that may be scanned via a mobile device to make a authorisation redirect to the bank (authURL encoded)." } } }, "ApiResponseOfPreAuthorisationResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/PreAuthorisationResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "PriorityCodeEnum": { "type": "string", "enum": [ "NORMAL", "URGENT" ] }, "ProprietaryBankTransactionCode": { "type": "object", "description": "Transaction code that is proprietary to the `Institution`.", "properties": { "code": { "type": "string", "description": "__Mandatory__. Proprietary code used to identify the underlying transaction." }, "issuer": { "type": "string", "description": "__Mandatory__. Issuer of the proprietary code." } } }, "RateTypeEnum": { "type": "string", "description": "__Mandatory__. The type used to complete the currency exchange.", "enum": [ "ACTUAL", "AGREED", "INDICATIVE" ] }, "RawRequest": { "type": "object", "properties": { "method": { "type": "string" }, "url": { "type": "string" }, "requestInstant": { "type": "string", "format": "date-time" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "body": { "type": "object" }, "bodyParameters": { "type": "object", "additionalProperties": { "type": "string" } }, "startTime": { "type": "string", "format": "date-time" }, "startedAt": { "type": "string", "format": "date-time", "deprecated": true } } }, "RawResponse": { "deprecated": true, "type": "object", "description": "[DEPRECATED] Interaction (raw request and response) that occurred with the `Institution` in order to fulfil a request.", "properties": { "request": { "$ref": "#/components/schemas/RawRequest" }, "duration": { "type": "string", "format": "iso8601" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "resultCode": { "type": "integer", "format": "int32" }, "result": { "type": "object" } } }, "RedirectRequest": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "__Mandatory__.Successful redirect after the user complete the authorisation at the `Institution`." } }, "description": "__Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`." }, "RefundAccount": { "type": "object", "description": "The account to which funds should be returned if the payment is to be later refunded.", "properties": { "name": { "type": "string" }, "accountIdentifications": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AccountIdentification" } } } }, "HostedVrpRefundAccount": { "type": "object", "description": "The account to which funds should be returned if the payment is to be later refunded.", "properties": { "name": { "type": "string" }, "accountIdentifications": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/HostedVrpAccountIdentification" } } } }, "ResponseForwardedData": { "type": "object", "properties": { "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "url": { "type": "string" } } }, "ResponseListMeta": { "type": "object", "properties": { "tracingId": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "pagination": { "$ref": "#/components/schemas/Pagination" } } }, "ApplicationResponseListMeta": { "type": "object", "properties": { "tracingId": { "type": "string" }, "count": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of applications in the current page." }, "pagination": { "type": "object", "properties": { "self": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int32", "minimum": 0, "description": "The number of skipped applications." }, "limit": { "type": "integer", "format": "int32", "minimum": 0, "description": "The maximum number of applications for the current page." }, "sort": { "type": "string", "description": "The field by which results are sorted by. Default direction is ascending, descending is identified by a \"-\" prefix." } } }, "totalCount": { "type": "integer", "format": "int32", "minimum": 0, "description": "The total number of applications that match the given filter." } } } } }, "ResponseMeta": { "type": "object", "properties": { "tracingId": { "type": "string" } } }, "ResponseMetaWithCount": { "type": "object", "properties": { "tracingId": { "type": "string" }, "count": { "type": "integer", "format": "int32" } } }, "ScaMethod": { "required": [ "id" ], "type": "object", "description": "__Conditional__. Used to update the authorisation with the sca method of the user's choice for the `Institution` that uses the embedded authorisation flow. If the user has multiple sca methods configured, the `Institution` will allow the user to select from each of these options.

When the user has multiple sca methods for the `Institution`, this is the second step required in the embedded authorisation flow to authorise the `Consent`.", "example": { "id": "944", "type": "PUSH_OTP", "description": "SecureSIGN" }, "properties": { "id": { "type": "string", "description": "__Mandatory__. The id of the sca method provided by the `Institution`", "example": "258211#OPTICAL" }, "type": { "$ref": "#/components/schemas/Type" }, "description": { "type": "string", "description": "__Optional__. A description of the sca method if provided by the `Institution`", "example": "Testkarte Hr. Haubach_1, optisch" }, "information": { "type": "string", "description": "Additional information from the institution to provide to the PSU to help with the selected SCA method. The language is determined by the institution and may vary.", "example": "Bitte bestätigen Sie den Vorgang in Ihrer SecureGo plus App" }, "data": { "description": "Data from the institution to provide to the PSU to complete authorisation. The language is determined by the institution and may vary.", "type": "array", "items": { "type": "string" }, "example": [ "0488701109982928CY439040000100000010000520,00" ] } } }, "SortEnum": { "type": "string", "description": "The attribute on which resources / records returned should be sorted. Valid options for the sort parameter.", "enum": [ "date", "-date" ] }, "StatementReference": { "type": "object", "description": "Unique reference for a statement period. This may be optionally populated if available.", "properties": { "value": { "type": "string" } } }, "Transaction": { "type": "object", "description": "Details of a transaction (credit or debit) that has occurred on the account.", "properties": { "id": { "type": "string", "description": "Unique identifier of the transaction." }, "date": { "type": "string", "format": "date-time" }, "bookingDateTime": { "type": "string", "description": "Date and time in UTC format of when a transaction was booked.", "format": "date-time" }, "valueDateTime": { "type": "string", "description": "Date and time in UTC format when the funds either cease to be available (for debit transactions) or become available (for credit transactions) to the account owner.", "format": "date-time" }, "status": { "$ref": "#/components/schemas/TransactionStatusEnum" }, "amount": { "type": "number", "description": "The transaction amount." }, "currency": { "type": "string", "description": "Currency the transaction amount is denoted in. Specified as a 3-letter ISO 4217 code." }, "transactionAmount": { "$ref": "#/components/schemas/Amount" }, "grossAmount": { "$ref": "#/components/schemas/Amount" }, "currencyExchange": { "$ref": "#/components/schemas/CurrencyExchange" }, "chargeDetails": { "$ref": "#/components/schemas/TransactionChargeDetails" }, "reference": { "type": "string" }, "statementReferences": { "type": "array", "items": { "$ref": "#/components/schemas/StatementReference" } }, "description": { "type": "string" }, "transactionInformation": { "type": "array", "description": "Further details on the transaction. This is narrative data, caught as unstructured text.", "items": { "type": "string" } }, "addressDetails": { "$ref": "#/components/schemas/AddressDetails" }, "isoBankTransactionCode": { "$ref": "#/components/schemas/IsoBankTransactionCode" }, "proprietaryBankTransactionCode": { "$ref": "#/components/schemas/ProprietaryBankTransactionCode" }, "balance": { "$ref": "#/components/schemas/TransactionBalance" }, "payeeDetails": { "type": "object", "description": "Details of the beneficiary [person or business].", "properties": { "name": { "type": "string", "description": "The account holder name of the Payee." }, "accountIdentifications": { "type": "array", "description": "The account identifications that identify the Payee's bank account.", "items": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/AccountIdentificationType" } ], "description": "Describes the format of the account." }, "identification": { "type": "string", "description": "The value associated with the account identification type." } } } } } }, "payerDetails": { "type": "object", "description": "Details of the benefactor [person or business].", "properties": { "name": { "type": "string", "description": "The account holder name of the Payer." }, "accountIdentifications": { "type": "array", "description": "The account identifications that identify the Payer's bank account.", "items": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/AccountIdentificationType" } ], "description": "Describes the format of the account." }, "identification": { "type": "string", "description": "The value associated with the account identification type." } } } } } }, "merchant": { "$ref": "#/components/schemas/Merchant" }, "enrichment": { "$ref": "#/components/schemas/Enrichment" }, "supplementaryData": { "type": "object", "description": "Additional information that cannot be captured in a structured field or block." }, "transactionMutability": { "type": "string", "description": "__Optional__. Specifies the Mutability of the Transaction record.", "example": "Mutable" } } }, "ApiListResponseOfTransaction": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "paging": { "$ref": "#/components/schemas/FilteredClientPayloadListTransaction" }, "tracingId": { "type": "string", "writeOnly": true } } }, "TransactionChargeDetails": { "type": "object", "description": "Details the charges that will apply to the transaction.", "properties": { "chargeAmount": { "$ref": "#/components/schemas/Amount" } } }, "TransactionHash": { "type": "object", "description": "An unique identifier for the transaction that was generated by Yapily. This is a hash of transaction attributes and may be useful an id is not present (and therefore hasn't been provided by an Institution).", "properties": { "hash": { "type": "string" } } }, "TransactionSchedule": { "description": "The frequency at which transactions occurred.", "properties": { "frequency": { "type": "string", "description": "How often the transaction happens. Can be 'Monthly', 'Twice monthly', 'Every two weeks', 'Every four weeks', 'Daily', 'Weekly', 'Every weekday', 'Twice daily', 'Twice every weekday'", "example": "Daily" }, "detailedFrequency": { "type": "string", "description": "When in the cycle the transaction occurs. Can be 'Daily', 'Twice daily', 'Twice every weekday', 'Every weekday', 'Weekly on day n', 'Every two weeks on day n', 'Monthly on working day before day n of month', 'Monthly on last working day of month', 'Twice a month on 15th and last working day of month', 'Every four weeks on day n'", "example": "Daily" }, "detailedFrequencyParameter": { "type": "number", "description": "The n in detailedFrequency where there is one - for week-based frequencies, an integer from 0 to 6 where 0 is Monday or for month-based frequencies, an integer from 0 to 27 where 0 is the first day of the month", "example": 1 } } }, "TransactionStatusEnum": { "type": "string", "enum": [ "BOOKED", "PENDING" ] }, "TransactionStream": { "description": "Lists all possible transaction streams identified for the `Application User`.", "properties": { "name": { "example": "Amazon Marketplace", "type": "string", "description": "The name of the Transaction Stream." }, "transactions": { "type": "array", "description": "A list of transaction details, identified by Yapily data services.", "items": { "$ref": "#/components/schemas/EnrichedTransaction" } }, "transactionSchedule": { "$ref": "#/components/schemas/TransactionSchedule" }, "scheduleConsistencyScore": { "type": "number", "description": "The consistency of the transaction. This is a number between 0 and 1 with 1 being the most consistent schedule.", "example": 0.44 }, "nextExpectedTransactionDate": { "type": "string", "format": "date", "description": "When is the transaction expected to occur next.", "example": "2019-10-04" }, "earliestTransactionDate": { "type": "string", "format": "date", "description": "When is the first recorded transaction date", "example": "2020-04-24" }, "mostRecentTransactionDate": { "type": "string", "format": "date", "description": "When is the most recent transaction date", "example": "2019-10-03" }, "amountConsistencyScore": { "type": "number", "description": "The consistency of the amount of the transaction. This is a number between 0 and 1 with 1 being the most consistent amount.", "example": 0.74 }, "averageAmount": { "type": "number", "description": "The average amount of the transaction stream", "example": 19.708 } } }, "TerminatedTransactionStream": { "description": "Terminated transaction stream generated as part of the financial profile for a User.", "properties": { "name": { "example": "Amazon Marketplace", "type": "string", "description": "The name of the TransactionStream" }, "transactions": { "type": "array", "description": "A list of Transactions from the transaction stream.", "items": { "$ref": "#/components/schemas/EnrichedTransaction" } }, "transactionSchedule": { "$ref": "#/components/schemas/TransactionSchedule" }, "scheduleConsistencyScore": { "type": "number", "description": "The consistency of the transaction. This is a number between 0 and 1 with 1 being the most consistent schedule.", "example": 0.44 }, "nextExpectedTransactionDate": { "type": "string", "format": "date", "description": "When is the transaction expected to occur next.", "example": "2019-10-04" }, "earliestTransactionDate": { "type": "string", "format": "date", "description": "When is the first recorded transaction date", "example": "2020-04-24" }, "mostRecentTransactionDate": { "type": "string", "format": "date", "description": "When is the most recent transaction date", "example": "2019-10-03" }, "amountConsistencyScore": { "type": "number", "description": "The consistency of the amount of the transaction. This is a number between 0 and 1 with 1 being the most consistent amount.", "example": 0.74 }, "averageAmount": { "type": "number", "description": "The average amount of the transaction stream", "example": 19.708 }, "missedTransactions": { "type": "integer", "format": "int32", "description": "Missed transactions of transaction stream", "example": 3 } } }, "Type": { "type": "string", "description": "The `SCA` method type available for the user", "enum": [ "SMS_OTP", "CHIP_OTP", "PHOTO_OTP", "PUSH_OTP" ] }, "UsageType": { "type": "string", "description": "The customer segment of the account.", "enum": [ "PERSONAL", "BUSINESS", "OTHER", "UNKNOWN" ] }, "UserCredentials": { "required": [ "id", "password" ], "type": "object", "properties": { "id": { "type": "string", "description": "__Mandatory__. The login id for the user for a particular `Institution`.", "example": "6154057725" }, "corporateId": { "type": "string", "description": "__Conditional__. The corporate login for the user for a particular corporate `Institution`.", "example": "6345898763" }, "password": { "type": "string", "description": "__Mandatory__. The password of the user to login to a particular `Institution`.", "example": "PISPWD12" } }, "description": "__Conditional__. Used to capture the user's credentials to allow them to login to an `Institution` that uses the embedded account authorisation flow.

This is the first step required in the embedded account authorisation flow to authorise the `Consent`." }, "UserDeleteResponse": { "type": "object", "description": "Deletion of the user. Includes the user profile and all associate consents.", "properties": { "id": { "type": "string", "description": "Unique identifier of the user." }, "deleteStatus": { "$ref": "#/components/schemas/DeleteStatusEnum" }, "creationDate": { "type": "string", "format": "date-time", "description": "Date and time that the user was created." }, "userConsents": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ConsentDeleteResponse" } } } }, "ApiResponseOfUserDeleteResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/UserDeleteResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "EventSubscriptionRequest": { "title": "Request to create a subscription for notifications", "type": "object", "required": [ "eventTypeId", "notification" ], "properties": { "eventTypeId": { "type": "string", "description": "Unique identifier of the event type (for which notifications will be sent).

Allowed values: payment.status, payment.status.completed, payment.isoStatus ", "example": "payment.status.completed" }, "notification": { "$ref": "#/components/schemas/Notification" } } }, "EventSubscriptionResponse": { "title": "Response on successful creation of event subscription", "type": "object", "required": [ "eventTypeId", "applicationId", "created", "notification" ], "properties": { "eventTypeId": { "type": "string", "description": "Unique identifier of the event type (for which notifications will be sent)", "example": "payment.status.completed" }, "applicationId": { "type": "string", "format": "uuid", "description": "Application related to event subscription.", "example": "2698db90-6635-4f76-b673-5ce8e2aeda0e" }, "created": { "type": "string", "description": "Creation date of event subscription.", "example": "28-07-2021 15:47:03" }, "notification": { "$ref": "#/components/schemas/Notification" } } }, "EventSubscriptionDeleteResponse": { "title": "Response upon successful unsubscribe on subscription", "type": "object", "required": [ "eventTypeId", "applicationId", "created", "deleteStatus" ], "properties": { "eventTypeId": { "type": "string", "description": "Unique identifier of the event type (for which notifications will be sent)", "example": "payment.status.completed" }, "applicationId": { "type": "string", "format": "uuid", "description": "Application related to event subscription.", "example": "2698db90-6635-4f76-b673-5ce8e2aeda0e" }, "created": { "type": "string", "format": "date-time", "description": "Creation datetime of event subscription.", "example": "28-07-2021 15:47:03" }, "deleteStatus": { "$ref": "#/components/schemas/DeleteStatusEnum" } } }, "Notification": { "description": "Subscription details for how and where to receive notifications.", "type": "object", "required": [ "type", "url" ], "properties": { "type": { "type": "string", "description": "How the notification will be delivered. This is currently only via WEBHOOK.", "example": "WEBHOOK" }, "url": { "type": "string", "description": "URL to which the notification will be sent.", "example": "https://httpbin.com/new_endpoint" } } }, "ApiResponseOfEventSubscriptionResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/EventSubscriptionResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "ApiListResponseOfEventSubscriptionResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EventSubscriptionResponse" } }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "paging": { "$ref": "#/components/schemas/FilteredClientPayloadListTransaction" }, "tracingId": { "type": "string", "writeOnly": true } } }, "ApiResponseOfEventSubscriptionDeleteResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/EventSubscriptionDeleteResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "ErrorIssue": { "required": [ "type", "code" ], "type": "object", "description": "Detailed information regarding the issue that was experienced during processing of the request", "properties": { "type": { "type": "string", "description": "Category of the issue" }, "code": { "type": "string", "description": "Code that uniquely identifies the type of issue" }, "parameter": { "type": "string", "description": "Identifies the parameter / property within the request (headers, query parameters or body) that the issue relates to. For headers and query parameters, it refers to the parameter name. For the body, it refers to the JSONPath of the property" }, "message": { "type": "string", "description": "Human readable description of the issue that was experienced" }, "institutionError": { "$ref": "#/components/schemas/InstitutionError" } } }, "ErrorDetails": { "required": [ "tracingId", "code", "status" ], "type": "object", "properties": { "tracingId": { "type": "string", "description": "Unique identifier of the request, used by Yapily for support purposes" }, "code": { "type": "integer", "format": "int32", "description": "Numeric HTTP status code associated with the error" }, "status": { "type": "string", "description": "Textual description of the HTTP status" }, "supportUrl": { "type": "string", "description": "Link to where further information regarding the error can be found" }, "source": { "type": "string", "description": "Source of the error. This may be YAPILY, the INSTITUTION, or the USER" }, "issues": { "type": "array", "description": "List of issues relating to the error", "items": { "$ref": "#/components/schemas/ErrorIssue" } } } }, "Links": { "type": "object", "properties": { "self": { "type": "string" }, "first": { "type": "string" }, "last": { "type": "string" }, "next": { "type": "string" }, "previous": { "type": "string" } } }, "VrpSweepingAuthorisationRequest": { "required": [ "institutionId", "controlParameters", "initiationDetails" ], "type": "object", "properties": { "userUuid": { "type": "string", "format": "uuid", "description": "__Conditional.__ The Yapily User UUID. One of `userUuid` or `applicationUserId` must be present in the request." }, "applicationUserId": { "type": "string", "description": "__Conditional.__ The Application User ID. One of `userUuid` or `applicationUserId` must be present in the request." }, "institutionId": { "type": "string", "description": "The Institution ID which will carry out authorisation." }, "callback": { "type": "string", "description": "__Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`.

See [Using a callback (Optional)](https://docs.yapily.com/knowledge/callback_url/#using-a-callback-optional) for more information." }, "redirect": { "$ref": "#/components/schemas/RedirectRequest" }, "forwardParameters": { "type": "array", "description": "Any parameters that you may want to get forwarded in the callback request after the PSU is redirected.", "items": { "type": "string" } }, "oneTimeToken": { "type": "boolean", "description": "__Conditional__. Set to `true` to receive a `oneTimeToken` instead of `consentToken` at the `callback`. This is used for additional security and can only be used when the `callback` is set.

See [Using a One-Time Token](https://docs.yapily.com/open-banking-flow/handling-redirects/callback-url#using-a-ott) for more information." }, "controlParameters": { "$ref": "#/components/schemas/VrpControlParameters" }, "initiationDetails": { "$ref": "#/components/schemas/VrpInitiationDetails" }, "complianceData": { "$ref": "#/components/schemas/VrpComplianceData" } } }, "VrpSweepingAuthorisationResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The Consent ID." }, "userUuid": { "type": "string", "format": "uuid", "description": "The Yapily User UUID (when provided in the request)." }, "applicationUserId": { "type": "string", "description": "The Application User ID (when provided in the request)." }, "institutionId": { "type": "string", "description": "The Institution ID which carried out authorisation." }, "status": { "$ref": "#/components/schemas/AuthorisationStatus" }, "createdAt": { "type": "string", "format": "date-time", "description": "The datetime when this consent was created." }, "featureScope": { "uniqueItems": true, "type": "array", "description": "The set of features associated with this consent.", "items": { "$ref": "#/components/schemas/FeatureEnum" } }, "consentToken": { "type": "string", "description": "The [Consent Token](https://docs.yapily.com/getting-started/glossary#consent-token)." }, "state": { "type": "string" }, "authorizedAt": { "type": "string", "format": "date-time" }, "institutionConsentId": { "type": "string", "description": "The Institution's Consent ID. Note that this cannot be used to interact with Yapily API." }, "authorisationUrl": { "type": "string", "description": "The Institution's URL to complete authorisation." }, "qrCodeUrl": { "type": "string", "description": "The QR code associated with the `authorisationUrl`. This provides a way for the user to access the URL via their mobile device." }, "controlParameters": { "$ref": "#/components/schemas/VrpControlParameters" }, "payer": { "$ref": "#/components/schemas/Payer" }, "initiationDetails": { "$ref": "#/components/schemas/VrpInitiationDetails" }, "riskDetails": { "$ref": "#/components/schemas/VrpSweepingRiskDetails" } } }, "VrpCommercialAuthorisationRequest": { "required": [ "institutionId", "controlParameters", "initiationDetails", "riskDetails" ], "type": "object", "properties": { "userUuid": { "type": "string", "format": "uuid", "description": "__Conditional.__ The Yapily User UUID. One of `userUuid` or `applicationUserId` must be present in the request." }, "applicationUserId": { "type": "string", "description": "__Conditional.__ The Application User ID. One of `userUuid` or `applicationUserId` must be present in the request." }, "institutionId": { "type": "string", "description": "The Institution ID which will carry out authorisation." }, "callback": { "type": "string", "description": "__Optional__. The server to redirect the user to after the user complete the authorisation at the `Institution`.

See [Using a callback (Optional)](https://docs.yapily.com/knowledge/callback_url/#using-a-callback-optional) for more information." }, "redirect": { "$ref": "#/components/schemas/RedirectRequest" }, "forwardParameters": { "type": "array", "description": "Extra parameters the TPP may want to get forwarded in the callback request after the PSU redirect.", "items": { "type": "string" } }, "oneTimeToken": { "type": "boolean", "description": "__Conditional__. Set to `true` to receive a `oneTimeToken` instead of `consentToken` at the `callback`. This is used for additional security and can only be used when the `callback` is set.

See [Using a One-Time Token](https://docs.yapily.com/open-banking-flow/handling-redirects/callback-url#using-a-ott) for more information." }, "controlParameters": { "$ref": "#/components/schemas/VrpControlParameters" }, "initiationDetails": { "$ref": "#/components/schemas/VrpInitiationDetails" }, "riskDetails": { "$ref": "#/components/schemas/VrpCommercialRiskDetails" }, "complianceData": { "$ref": "#/components/schemas/VrpComplianceData" } } }, "VrpCommercialAuthorisationResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The Consent ID." }, "userUuid": { "type": "string", "format": "uuid", "description": "The Yapily User UUID (when provided in the request)." }, "applicationUserId": { "type": "string", "description": "The Application User ID (when provided in the request)." }, "institutionId": { "type": "string", "description": "The Institution ID which carried out authorisation." }, "status": { "$ref": "#/components/schemas/AuthorisationStatus" }, "createdAt": { "type": "string", "format": "date-time", "description": "The datetime when this consent was created." }, "featureScope": { "uniqueItems": true, "type": "array", "description": "The set of features associated with this consent.", "items": { "$ref": "#/components/schemas/FeatureEnum" } }, "consentToken": { "type": "string", "description": "The [Consent Token](https://docs.yapily.com/getting-started/glossary#consent-token)." }, "state": { "type": "string" }, "authorizedAt": { "type": "string", "format": "date-time" }, "institutionConsentId": { "type": "string", "description": "The Institution's Consent ID. Note that this cannot be used to interact with Yapily API." }, "authorisationUrl": { "type": "string", "description": "The Institution's URL to complete authorisation." }, "qrCodeUrl": { "type": "string", "description": "The QR code associated with the `authorisationUrl`. This provides a way for the user to access the URL via their mobile device." }, "controlParameters": { "$ref": "#/components/schemas/VrpControlParameters" }, "initiationDetails": { "$ref": "#/components/schemas/VrpInitiationDetails" }, "riskDetails": { "$ref": "#/components/schemas/VrpCommercialRiskDetails" } } }, "ApiResponseOfVrpSweepingAuthorisationResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/VrpSweepingAuthorisationResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "tracingId": { "type": "string", "writeOnly": true }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } } } }, "ApiResponseOfVrpCommercialAuthorisationResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/VrpCommercialAuthorisationResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "tracingId": { "type": "string", "writeOnly": true }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } } } }, "VrpInitiationDetails": { "type": "object", "description": "The definition of the payer and payee.", "properties": { "reference": { "type": "string", "description": "The reference/description of the payments that will be carried out on this VRP consent." }, "payer": { "$ref": "#/components/schemas/Payer" }, "payee": { "$ref": "#/components/schemas/Payee" } } }, "VrpControlParameters": { "type": "object", "description": "The definition of VRP parameters.", "required": [ "psuAuthenticationMethods", "maxAmountPerPayment", "periodicLimits" ], "properties": { "psuAuthenticationMethods": { "type": "array", "items": { "type": "string" }, "description": "Defines the authentication method(s) allowed in payment submission step.
Allowed values are [`SCA_REQUIRED`, `SCA_NOT_REQUIRED`].

See [SCA](https://docs.yapily.com/getting-started/glossary#strong-customer-authentication-sca)." }, "maxAmountPerPayment": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "The maximum amount that will be allowed per VRP payment." }, "periodicLimits": { "type": "array", "description": "The maximum amount over all VRP payments within the specified periods. For instance, a `MONTHLY` limit of `20 GBP`.

See [VRP Mandate Details](https://docs.yapily.com/payments/vrps/mandate-details).", "items": { "$ref": "#/components/schemas/VrpPeriodicLimits" } }, "validFrom": { "type": "string", "format": "date-time", "description": "The start date when the consent becomes valid." }, "validTo": { "type": "string", "format": "date-time", "description": "The end date when the consent expires and becomes invalid." } } }, "VrpFundsAvailable": { "required": [ "fundsAvailable", "fundsAvailableAt" ], "type": "object", "properties": { "fundsAvailable": { "type": "boolean", "description": "The flag indicating whether the funds are available." }, "fundsAvailableAt": { "type": "string", "format": "date-time", "description": "The datetime when the funds were checked." } } }, "VrpFundsConfirmationRequest": { "type": "object", "required": [ "paymentAmount" ], "properties": { "paymentAmount": { "$ref": "#/components/schemas/Amount" }, "reference": { "type": "string", "description": "The reference/description associated with the VRP consent." } } }, "VrpFundsConfirmationResponse": { "required": [ "paymentAmount", "fundsAvailable" ], "type": "object", "properties": { "id": { "type": "string" }, "reference": { "type": "string" }, "paymentAmount": { "$ref": "#/components/schemas/Amount" }, "fundsAvailable": { "$ref": "#/components/schemas/VrpFundsAvailable" } } }, "ApiResponseOfVrpFundsConfirmationResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/VrpFundsConfirmationResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "tracingId": { "type": "string", "writeOnly": true }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } } } }, "VrpSweepingRiskDetails": { "type": "object", "description": "The details required by the institutions to detect and prevent fraud.", "properties": { "paymentContextCode": { "type": "string" } } }, "VrpCommercialRiskDetails": { "type": "object", "description": "The details required by the institutions to detect and prevent fraud.", "required": [ "paymentContextCode", "paymentPurposeCode", "categoryPurposeCode", "merchantCustomerId", "isContractPresent", "isBeneficiaryPrepopulated" ], "properties": { "paymentContextCode": { "type": "string" }, "paymentPurposeCode": { "type": "string" }, "categoryPurposeCode": { "type": "string" }, "merchantCustomerId": { "type": "string", "description": "The merchant's identifier for the customer associated with the payment." }, "isContractPresent": { "type": "boolean", "description": "Set to `true` when you have a contractual relationship with Yapily. This is overridden according to the value in your application configuration." }, "isBeneficiaryPrepopulated": { "type": "boolean", "description": "Set to `true` when the `payee` details were populated automatically (as opposed to being manually provided by the payee)." }, "beneficiaryAccountType": { "type": "string" } } }, "VrpComplianceData": { "type": "object", "properties": { "payer": { "$ref": "#/components/schemas/VrpComplianceDataPayer" } }, "description": "__Conditional__. Information needed to complete compliance checks. Mandatory for Yapily Connect customers." }, "VrpComplianceDataPayer": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "example": "INDIVIDUAL", "description": "The payer type. Allowed values: INDIVIDUAL, BUSINESS. The corresponding object must be included." }, "individual": { "$ref": "#/components/schemas/VrpComplianceDataIndividual" }, "business": { "$ref": "#/components/schemas/VrpComplianceDataBusiness" } }, "description": "__Conditional__. Payer details required for compliance checks." }, "VrpComplianceDataIndividual": { "type": "object", "required": [ "name", "birthDate" ], "properties": { "name": { "type": "string", "example": "John Doe", "description": "This is the first and last name of your end user." }, "birthDate": { "type": "string", "format": "date", "example": "2000-08-12", "description": "This is the date of birth of your end user." } }, "description": "__Conditional__. Mandatory if the type is INDIVIDUAL." }, "VrpComplianceDataBusiness": { "type": "object", "required": [ "name", "registrationNumber", "registeredAddress" ], "properties": { "name": { "type": "string", "example": "Company LTD", "description": "This is the registered company name of your end user." }, "registrationNumber": { "type": "string", "example": "COM123NO", "description": "This is the registered company number of the business." }, "registeredAddress": { "$ref": "#/components/schemas/VrpComplianceDataAddress" }, "tradingAddress": { "$ref": "#/components/schemas/VrpComplianceDataAddress" } }, "description": "__Conditional__. Mandatory if the type is BUSINESS." }, "VrpComplianceDataAddress": { "type": "object", "required": [ "addressLine1", "townName", "postCode", "country" ], "properties": { "addressLine1": { "type": "string", "example": "123 Queens Street", "description": "__Mandatory__. AddressLine1 of the business." }, "addressLine2": { "type": "string", "example": "Unit 13", "description": "__Optional__. AddressLine2 of the business." }, "townName": { "type": "string", "example": "York", "description": "__Mandatory__. Town name of the business." }, "postCode": { "type": "string", "example": "12345", "description": "__Mandatory__. Post code of the business." }, "country": { "type": "string", "example": "GB", "description": "__Mandatory__. Country of the business." } }, "description": "This is the registered company or trading address of your end user." }, "VrpSubmissionDetails": { "type": "object", "required": [ "payee", "paymentAmount" ], "properties": { "reference": { "type": "string", "description": "The reference/description associated with the VRP consent." }, "payee": { "$ref": "#/components/schemas/Payee" }, "paymentAmount": { "$ref": "#/components/schemas/Amount" } } }, "VrpSubmissionRequest": { "type": "object", "required": [ "paymentIdempotencyId", "psuAuthenticationMethod", "paymentAmount" ], "properties": { "paymentIdempotencyId": { "type": "string", "description": "A unique identifier for the payment.

This can be any alpha-numeric string but is limited to a maximum of 35 characters." }, "psuAuthenticationMethod": { "type": "string", "description": "Defines the authentication method(s) allowed in payment submission step.
Allowed values are [`SCA_REQUIRED`, `SCA_NOT_REQUIRED`].

See [SCA](https://docs.yapily.com/getting-started/glossary#strong-customer-authentication-sca)." }, "paymentAmount": { "$ref": "#/components/schemas/Amount" } } }, "VrpSubmissionResponse": { "type": "object", "required": [ "initiationDetails", "submissionDetails" ], "properties": { "id": { "type": "string", "description": "The Payment ID." }, "paymentIdempotencyId": { "type": "string", "description": "The Payment Idempotency ID (as provided in the request)." }, "paymentLifecycleId": { "type": "string" }, "institutionConsentId": { "type": "string", "description": "The Institution's Consent ID on which the payment was submitted. Note that this cannot be used to interact with Yapily API." }, "status": { "$ref": "#/components/schemas/PaymentStatus" }, "statusDetails": { "$ref": "#/components/schemas/PaymentStatusDetails" }, "initiationDetails": { "$ref": "#/components/schemas/VrpInitiationDetails" }, "submissionDetails": { "$ref": "#/components/schemas/VrpSubmissionDetails" }, "payer": { "$ref": "#/components/schemas/Payer" }, "refundAccount": { "$ref": "#/components/schemas/RefundAccount" }, "expectedExecutionTime": { "type": "string", "format": "date-time" }, "expectedSettlementTime": { "type": "string", "format": "date-time" }, "riskDetails": { "$comment": "NOTE: This model is shared between Sweeping and Commercial, but we use VrpSweepingRiskDetails because it is minimal and sufficient!", "$ref": "#/components/schemas/VrpSweepingRiskDetails" } } }, "ApiResponseOfVrpSubmissionResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/VrpSubmissionResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string" } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "tracingId": { "type": "string", "writeOnly": true }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } } } }, "VrpPeriodicLimits": { "required": [ "frequency", "totalMaxAmount", "alignment" ], "type": "object", "properties": { "frequency": { "type": "string", "description": "The frequency/period over which the limit is enforced.
Allowed values are [`DAILY`, `WEEKLY`, `EVERY_TWO_WEEKS`, `MONTHLY`, `YEARLY`]." }, "totalMaxAmount": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "The maximum amount that will be allowed over the specified frequency/period.

If the `alignment` is set to `CALENDAR`, then the limit will be [pro-rated](https://docs.yapily.com/payments/vrps/mandate-details#pro-rata-calculation) in the first period to the remaining number of days." }, "alignment": { "type": "string", "description": "The alignment of the frequency/period for which the limit is enforced. Allowed values are [`CONSENT`, `CALENDAR`].

See [VRP Mandate Details](https://docs.yapily.com/payments/vrps/mandate-details)." } } }, "ApiListResponseOfRealTimeTransaction": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMetaWithCount" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RealTimeTransaction" } }, "links": { "type": "object", "properties": { "first": { "type": "string", "description": "A cursor or link to the first page in the data set." }, "prev": { "type": "string", "description": "A cursor or link to the previous page in the data set." }, "self": { "type": "string", "description": "A cursor or link to the current page in the data set." }, "next": { "type": "string", "description": "A cursor or link to the next page in the data set." }, "last": { "type": "string", "description": "A cursor or link to the last page in the data set." } } }, "forwardedData": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseForwardedData" } }, "raw": { "deprecated": true, "type": "array", "items": { "$ref": "#/components/schemas/RawResponse" } }, "tracingId": { "type": "string", "writeOnly": true } } }, "RealTimeTransaction": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "bookingDateTime": { "type": "string", "format": "date-time" }, "valueDateTime": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/TransactionStatusEnum" }, "transactionAmount": { "$ref": "#/components/schemas/Amount" }, "grossAmount": { "$ref": "#/components/schemas/Amount" }, "currencyExchange": { "$ref": "#/components/schemas/CurrencyExchange" }, "chargeDetails": { "$ref": "#/components/schemas/TransactionChargeDetails" }, "reference": { "type": "string" }, "statementReferences": { "type": "array", "items": { "$ref": "#/components/schemas/StatementReference" } }, "description": { "type": "string" }, "transactionInformation": { "type": "array", "items": { "type": "string" } }, "addressDetails": { "$ref": "#/components/schemas/AddressDetails" }, "isoBankTransactionCode": { "$ref": "#/components/schemas/IsoBankTransactionCode" }, "proprietaryBankTransactionCode": { "$ref": "#/components/schemas/ProprietaryBankTransactionCode" }, "balance": { "$ref": "#/components/schemas/TransactionBalance" }, "payeeDetails": { "$ref": "#/components/schemas/Payee" }, "payerDetails": { "$ref": "#/components/schemas/Payer" }, "merchant": { "$ref": "#/components/schemas/Merchant" }, "supplementaryData": { "type": "object" } } }, "CreateHostedConsentRequest": { "required": [ "redirectUrl", "institutionIdentifiers" ], "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "description": "__Conditional__. Yapily Identifier for the `User` returned by the create user step POST /users. You must provide either a `userId` or `applicationUserId`." }, "applicationUserId": { "type": "string", "description": "__Conditional__. Your own `User` reference. This field allows you to use your own unique references for individual users. Where the `User` reference doesn't have an associated Yapily `userId`, a new `userId` is created and linked to it. You must provide either a `userId` or `applicationUserId`." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiers" }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "redirectUrl": { "type": "string", "description": "URL of your server to redirect the user after completion of the consent flow.", "example": "https://tpp-application.com" }, "oneTimeToken": { "type": "boolean", "description": "Used to receive a oneTimeToken rather than a consentToken at the redirectUrl for additional security.", "example": "false" }, "accountRequest": { "$ref": "#/components/schemas/HostedAccountRequest" } } }, "CreateHostedPaymentRequest": { "required": [ "redirectUrl", "paymentRequestDetails", "institutionIdentifiers" ], "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "description": "__Conditional__. Yapily Identifier for the `User` returned by the create user step POST /users. You must provide either a `userId` or `applicationUserId`." }, "applicationUserId": { "type": "string", "description": "__Conditional__. Your own `User` reference. This field allows you to use your own unique references for individual users. Where the `User` reference doesn't have an associated Yapily `userId`, a new `userId` is created and linked to it. You must provide either a `userId` or `applicationUserId`." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiers" }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "redirectUrl": { "type": "string", "description": "URL of your server to redirect the user after completion of the payment flow.", "example": "https://tpp-application.com" }, "paymentRequestDetails": { "$ref": "#/components/schemas/HostedPaymentRequestDetails" } } }, "CreateHostedPaymentRequestLink": { "required": [ "redirectUrl", "paymentRequestDetails", "institutionIdentifiers" ], "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "description": "__Conditional__. Yapily Identifier for the `User` returned by the create user step POST /users. You must either provide `userId` or `applicationUserId`." }, "applicationUserId": { "type": "string", "description": "__Conditional__. Your own `User` reference. If you want to work with their own unique references for individual PSUs then you can use the `applicationUserId` property to provide that value. Where Yapily does not already have a Yapily userId that matches the supplied `applicationUserId`, then a new Yapily userId is created automatically and linked to the `applicationUserId` value. You must either provide userId or `applicationUserId`." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiers" }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "redirectUrl": { "type": "string", "description": "URL of your server to redirect the user after completion of the payment flow.", "example": "https://tpp-application.com" }, "authorisationExpiresAt": { "type": "string", "format": "date-time", "description": "The date and time that the authorisation expires. Must be between 10 minutes and 30 days in the future. If not specified, the authorisation URL will expire 10 minutes after creation." }, "paymentRequestDetails": { "$ref": "#/components/schemas/HostedPaymentRequestDetailsLink" } } }, "InstitutionIdentifiers": { "description": "Specifies the institution requirements for making the payment. Skips the bank selection screen in payment flow if the `institutionId` and `institutionCountryCode` are provided.", "type": "object", "required": [ "institutionCountryCode" ], "properties": { "institutionId": { "type": "string", "description": "Yapily identifier which identifies the `Institution` the payment request is sent to." }, "institutionCountryCode": { "type": "string", "description": "2 letter ISO Country code of the `Institution` the payment request is sent to.", "example": "GB" } } }, "InstitutionIdentifiersResponse": { "description": "Specifies the institution selected for making the payment.", "type": "object", "properties": { "institutionId": { "type": "string", "description": "Yapily identifier which identifies the `Institution` the payment request is sent to." }, "institutionCountryCode": { "type": "string", "description": "2 letter ISO Country code of the `Institution` the payment request is sent to.", "example": "GB" } } }, "UserSettings": { "description": "Specifies the language and location preferences of the user.", "type": "object", "properties": { "language": { "type": "string", "description": "2 letter ISO Language code which denotes the language preference for the `User`.", "example": "en" }, "location": { "type": "string", "description": "2 letter ISO Country code which denotes the location preference for the `User`.", "example": "GB" } } }, "HostedPaymentRequestDetails": { "description": "Details of the payment.", "required": [ "paymentIdempotencyId", "type", "payee", "amountDetails" ], "type": "object", "properties": { "paymentIdempotencyId": { "type": "string", "description": "A unique identifier that you must provide to identify the payment. This can be any alpha-numeric string but is limited to a maximum of 35 characters.", "example": "04ab4536gaerfc0e1f93c4f4" }, "reference": { "type": "string", "description": "The payment reference or description. Limited to a maximum of 18 characters for UK institutions.", "example": "Bill payment" }, "contextType": { "$ref": "#/components/schemas/PaymentContextType" }, "type": { "$ref": "#/components/schemas/PaymentType" }, "payee": { "$ref": "#/components/schemas/Payee" }, "payer": { "$ref": "#/components/schemas/Payer" }, "amountDetails": { "$ref": "#/components/schemas/HostedAmountDetails" }, "paymentDueDate": { "type": "string", "format": "date", "description": "The date that the payment is due. Displayed to the end user in the payment summary screen." } } }, "HostedPaymentResponseDetails": { "description": "Details of the payment.", "type": "object", "properties": { "paymentIdempotencyId": { "type": "string", "description": "A unique identifier provided to identify the payment. This can be any alpha-numeric string but is limited to a maximum of 35 characters.", "example": "04ab4536gaerfc0e1f93c4f4" }, "reference": { "type": "string", "description": "The payment reference or description. Limited to a maximum of 18 characters for UK institutions.", "example": "Bill payment" }, "contextType": { "$ref": "#/components/schemas/PaymentContextTypeResponse" }, "type": { "$ref": "#/components/schemas/PaymentTypeResponse" }, "payee": { "$ref": "#/components/schemas/PayeeDetailsResponse" }, "payer": { "$ref": "#/components/schemas/PayerDetailsResponse" }, "amountDetails": { "$ref": "#/components/schemas/AmountDetailsResponse" }, "paymentDueDate": { "type": "string", "format": "date", "description": "The date that the payment is due." } } }, "HostedPaymentRequestDetailsLink": { "type": "object", "properties": { "reference": { "type": "string", "description": "The payment reference or description. Limited to a maximum of 18 characters for UK institutions.", "example": "Bill payment" }, "contextType": { "$ref": "#/components/schemas/PaymentContextTypeResponse" }, "type": { "$ref": "#/components/schemas/PaymentTypeResponse" }, "payee": { "$ref": "#/components/schemas/PayeeDetailsResponse" }, "payer": { "$ref": "#/components/schemas/PayerDetailsResponse" }, "amountDetails": { "$ref": "#/components/schemas/AmountDetailsResponse" }, "paymentDueDate": { "type": "string", "format": "date", "description": "The date that the payment is due. Displayed to the end user in the payment summary screen." } } }, "HostedAmountDetails": { "required": [ "amountToPay", "currency" ], "type": "object", "properties": { "amountToPay": { "type": "number", "description": "The payment amount", "minimum": 0.01, "example": 10.50 }, "currency": { "type": "string", "description": "The [ISO 4217](https://www.xe.com/iso4217.php) currency code", "example": "GBP" } }, "description": "The payment amount and currency" }, "HostedConsentRequestResponse": { "type": "object", "properties": { "consentRequestId": { "type": "string", "format": "uuid", "description": "Unique Id of the consent request." }, "userId": { "type": "string", "format": "uuid", "description": "Unique Id for the `User` assigned by Yapily." }, "applicationUserId": { "type": "string", "description": "Your reference to the `User`." }, "applicationId": { "type": "string", "format": "uuid", "description": "Unique Id of the `Application` the user is associated with." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiersResponse" }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "redirectUrl": { "type": "string", "description": "URL of consent server to redirect the user after completion of the consent flow.", "example": "https://tpp-application.com" }, "accountRequestDetails": { "$ref": "#/components/schemas/HostedAccountRequestDetailsResponse" }, "hostedUrl": { "type": "string", "description": "The URL of Hosted UI page for the applicationId which initiates the user journey for the consent.
URL would be appended with authToken, applicationId and userSettings." }, "createdAt": { "type": "string", "format": "date-time", "description": "The date and time at which the consent was created." }, "authorisationExpiresAt": { "type": "string", "format": "date-time", "description": "The date and time at which the auth Token will expire." } } }, "HostedAccountRequestDetailsResponse": { "description": "Details of the Account Request.", "type": "object", "properties": { "transactionFrom": { "type": "string", "description": "Specifies the earliest date of the transaction records to be returned.

You must supply this field to retrieve transactions older than 90 days for banks accessed via the the [CBI Globe Gateway](https://docs.yapily.com/pages/data/financial-data-resources/data-restrictions/#cbi-globe-gateway).", "format": "date-time", "example": "2020-01-01T00:00:00Z" }, "transactionTo": { "type": "string", "description": "Specifies the latest date of the transaction records to be returned.", "format": "date-time", "example": "2021-01-01T00:00:00Z" }, "expiresAt": { "type": "string", "description": "Specify the set a hard date for when the user's associated `Consent` will expire.

**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.

**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", "example": "2025-01-01T00:00:00Z" }, "featureScope": { "uniqueItems": true, "type": "array", "description": "Specify the set of features that the user will give their consent for when requesting access to their account information. Depending on the `Institution`, this may also populate a consent screen which list these scopes before the user authorises.

This endpoint accepts allow all [Financial Data Features](/guides/financial-data/features/#feature-list) that the `Institution` supports.To find out which scopes an `Institution` supports, check [GET Institution](./#get-institution).", "items": { "$ref": "#/components/schemas/FeatureEnum" } } } }, "HostedPaymentRequestResponse": { "type": "object", "properties": { "paymentRequestId": { "type": "string", "format": "uuid", "description": "Unique Id of the payment request." }, "userId": { "type": "string", "format": "uuid", "description": "Unique Id for the `User` assigned by Yapily." }, "applicationUserId": { "type": "string", "description": "Your reference to the `User`." }, "applicationId": { "type": "string", "format": "uuid", "description": "Unique Id of the `Application` the user is associated with." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiersResponse" }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "redirectUrl": { "type": "string", "description": "URL of payment server to redirect the user after completion of the payment flow.", "example": "https://tpp-application.com" }, "paymentRequestDetails": { "$ref": "#/components/schemas/HostedPaymentResponseDetails" }, "hostedUrl": { "type": "string", "description": "The URL of Hosted UI page for the applicationId which initiates the user journey for the payment.
URL would be appended with authToken, applicationId and userSettings." }, "createdAt": { "type": "string", "format": "date-time", "description": "The date and time at which the payment was created." }, "authorisationExpiresAt": { "type": "string", "format": "date-time", "description": "The date and time at which the auth Token will expire." }, "status": { "type": "string", "description": "Current status of the payment request." } } }, "HostedPaymentPhase": { "type": "object", "properties": { "phaseName": { "type": "string", "description": "The name of the hosted payment process phase. Allowed values are : " }, "phaseCreatedAt": { "type": "string", "format": "date-time", "description": "The date and time when phase of the hosted payment was inserted." } }, "description": "The phase of the payment." }, "HostedPaymentStatusDetails": { "description": "The status of the payment.", "type": "object", "properties": { "status": { "$ref": "#/components/schemas/PaymentStatus" }, "statusUpdateDate": { "description": "Date and time the status was updated.", "type": "string", "format": "date-time" }, "isoStatus": { "$ref": "#/components/schemas/HostedPaymentIsoStatus" } } }, "HostedPaymentIsoStatus": { "description": "The ISO status of the payment.", "type": "object", "properties": { "code": { "type": "string", "description": "The ISO 20022 `PaymentStatusCode`. One of :
ACSC
ACCC
ACCP
ACSP
ACTC
ACWC
ACWP
ACFC
RCVD
PART
PATC
PDNG
RJCT
CANC", "example": "ACSC" }, "name": { "type": "string", "description": "The full name of the ISO 20022 `PaymentStatusCode`.", "example": "AcceptedCreditSettlementCompleted" } } }, "ApiResponseOfGetHostedConsentRequest": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/HostedGetConsentRequestResponse" } } }, "HostedGetConsentRequestResponse": { "type": "object", "properties": { "consentRequestId": { "type": "string", "format": "uuid", "description": "Unique Id of the consent request." }, "consentId": { "type": "string", "format": "uuid", "description": "Identification of the consent." }, "userId": { "type": "string", "format": "uuid", "description": "Unique Id for the `User` assigned by Yapily." }, "applicationUserId": { "type": "string", "description": "Your reference to the `User`." }, "applicationId": { "type": "string", "format": "uuid", "description": "Unique Id of the `Application` the user is associated with." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiersResponse" }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "redirectUrl": { "type": "string", "description": "URL of consent server to redirect the user after completion of the consent flow.", "example": "https://tpp-application.com" }, "createdAt": { "type": "string", "format": "date-time", "description": "The date and time at which the payment was created." }, "authorisationExpiresAt": { "type": "string", "format": "date-time", "description": "The date and time at which the auth Token will expire." }, "status": { "type": "string", "description": "Current status of the consent request. Allowed values are [AWAITING_AUTHORIZATION, AUTHORIZED, REJECTED, REVOKED, FAILED, EXPIRED, AWAITING_DECOUPLED_AUTHORIZATION]" }, "phases": { "description": "The phase reached by the consent and its timestamp.", "type": "array", "items": { "$ref": "#/components/schemas/HostedConsentPhase" } }, "consentToken": { "type": "string", "description": "Represents the authorisation to gain access to the requested features. Required to access account information." } } }, "HostedConsentPhase": { "type": "object", "properties": { "phaseName": { "type": "string", "description": "The name of the hosted consent process phase. Allowed values are : " }, "phaseCreatedAt": { "type": "string", "format": "date-time", "description": "The date and time at which the phase of the hosted Consent was created." } }, "description": "The phase of the Consent Request." }, "ApiResponseOfGetHostedPaymentRequest": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/HostedPaymentDetails" } } }, "HostedPaymentDetails": { "type": "object", "properties": { "paymentRequestId": { "type": "string", "format": "uuid", "description": "The unique ID of the payment request." }, "userId": { "type": "string", "format": "uuid", "description": "The Unique Identifier for the `User` assigned by Yapily." }, "applicationUserId": { "type": "string", "description": "Your reference to the `User`." }, "applicationId": { "type": "string", "format": "uuid", "description": "The Unique Identifier of the `Application` the user is associated with." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiersResponse" }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "redirectUrl": { "type": "string", "description": "URL of your server to redirect the user after completion of the payment flow.", "example": "https://tpp-application.com" }, "paymentRequestDetails": { "$ref": "#/components/schemas/HostedPaymentRequestDetailsLink" }, "createdAt": { "type": "string", "description": "The date and time at which the payment request was created.", "format": "date-time" }, "authorisationExpiresAt": { "type": "string", "format": "date-time", "description": "The date and time at which the auth Token will expire." }, "status": { "type": "string", "description": "Current status of the payment request.
Possible values:
ACTIVE
INACTIVE" }, "payments": { "uniqueItems": true, "type": "array", "description": "Payments that have been initiated as part of this request", "items": { "$ref": "#/components/schemas/HostedPayment" } } } }, "HostedPayment": { "type": "object", "properties": { "paymentId": { "type": "string", "format": "uuid", "description": "The Unique Identifier of the payment." }, "hostedPaymentId": { "type": "string", "format": "uuid", "description": "The Unique Identifier of the payment created using Yapily hosted application." }, "consentId": { "type": "string", "format": "uuid", "description": "The Unique Identifier of the consent." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiersResponse" }, "phases": { "description": "The phase reached by the payment and its timestamp.", "type": "array", "items": { "$ref": "#/components/schemas/HostedPaymentPhase" } }, "paymentStatus": { "type": "string", "description": "Payment status based on latest HostedAuthPaymentPhase in phases. Value can be " }, "statusDetails": { "description": "Details of the payment status.", "type": "array", "items": { "$ref": "#/components/schemas/HostedPaymentStatusDetails" } }, "institutionPaymentId": { "type": "string", "description": "The Unique Identifier of the payment created with the `Institution`." }, "paymentLifecycleId": { "type": "string", "description": "The Unique Identifier provided by TPP in the Payment request to identify the payment." }, "paymentIdempotencyId": { "type": "string", "description": "A unique identifier that you must provide to identify the payment. This can be any alpha-numeric string but is limited to a maximum of 35 characters.", "example": "04ab4536gaerfc0e1f93c4f4" }, "reference": { "type": "string", "description": "The payment reference or description. Limited to a maximum of 18 characters for UK institutions.", "example": "Bill payment" }, "contextType": { "$ref": "#/components/schemas/PaymentContextTypeResponse" }, "type": { "$ref": "#/components/schemas/PaymentTypeResponse" }, "payee": { "$ref": "#/components/schemas/PayeeDetailsResponse" }, "payer": { "$ref": "#/components/schemas/PayerDetailsResponse" }, "amount": { "$ref": "#/components/schemas/AmountDetailsResponse" } } }, "ApiResponseOfCreateHostedConsentRequest": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/HostedConsentRequestResponse" } } }, "ApiResponseOfCreateHostedPaymentRequest": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/HostedPaymentRequestResponse" } } }, "ApiResponseOfCreateHostedPaymentRequestLink": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/HostedPaymentRequestResponse" } } }, "CreateHostedVRPConsentRequest": { "required": [ "redirectUrl", "institutionIdentifiers", "vrpSetup" ], "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "description": "__Conditional__. Yapily Identifier for the `User` returned by the create user step POST /users. Clients must either provide userId or applicationUserId." }, "applicationUserId": { "type": "string", "description": "__Conditional__. Client's own `User` reference. If the client wants to work with their own unique references for individual PSUs then they can use the applicationUserId property to provide that value. Where Yapily does not already have a Yapily userId that matches the supplied applicationUserId, then a new Yapily userId is created automatically and linked to the applicationUserId value. Clients must either provide userId or applicationUserId." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiers" }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "redirectUrl": { "type": "string", "description": "URL of client's server to redirect the PSU after completion of the consent authorisation.", "example": "https://tpp-application.com" }, "oneTimeToken": { "type": "boolean", "description": "Used to receive a oneTimeToken rather than a consentToken at the redirectUrl for additional security. This can only be used when the redirectUrl is set.", "example": "false" }, "vrpSetup": { "$ref": "#/components/schemas/VRPSetupRequest" } } }, "ApiResponseOfCreateHostedVRPConsentRequest": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/HostedVRPConsentRequestResponse" } } }, "ApiResponseOfGetHostedVRPConsentRequest": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/HostedVRPConsentDetails" } } }, "ApiResponseOfGetHostedVRPConsentsRequest": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/GetHostedVRPConsentsResponse" } } }, "ApiResponseOfRevokeHostedVRPConsentRequest": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/HostedVRPConsentDetails" } } }, "HostedVRPConsentDetails": { "required": [ "id", "consentStatus", "applicationId", "vrpSetup" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The unique ID of the consent request." }, "userId": { "type": "string", "format": "uuid", "description": "Represents the Unique Identifier for the `User` assigned by Yapily." }, "applicationUserId": { "type": "string", "description": "Represents the User-friendly reference to the `User`." }, "applicationId": { "type": "string", "format": "uuid", "description": "Represents the Unique Identifier of the `Application` the user is associated with." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiers" }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "redirectUrl": { "type": "string", "description": "URL of client's server to redirect the PSU after completion of the consent authorisation.", "example": "https://tpp-application.com" }, "vrpSetup": { "$ref": "#/components/schemas/VRPSetup" }, "createdAt": { "type": "string", "format": "date-time" }, "authorisationExpiresAt": { "type": "string", "format": "date-time", "description": "Represents the date and time at which the auth Token will expire." }, "consentToken": { "type": "string", "description": "Represents the authorisation to make VRP payments" }, "consentStatus": { "type": "string", "description": "Current status of the authorisation. Can be one of [AWAITING_AUTHORIZATION, AUTHORIZED, REJECTED, REVOKED, FAILED, EXPIRED]" }, "phases": { "type": "array", "items": { "$ref": "#/components/schemas/HostedVRPPhase" } } } }, "CreateHostedVRPPaymentRequest": { "required": [ "paymentIdempotencyId", "amount" ], "type": "object", "properties": { "paymentIdempotencyId": { "type": "string", "description": "__Mandatory__. A unique identifier that you must provide to identify the payment. This can be any alpha-numeric string but is limited to a maximum of 35 characters.", "example": "04ab4536gaerfc0e1f93c4f4" }, "amount": { "$ref": "#/components/schemas/Amount" } }, "description": "__Mandatory__. The payment request object defining the details of the payment for execution under the Variable Recurring Payment consent." }, "HostedVRPPaymentResponse": { "type": "object", "properties": { "id": { "type": "string" }, "paymentIdempotencyId": { "type": "string" }, "amount": { "$ref": "#/components/schemas/Amount" }, "reference": { "type": "string", "description": "__Optional__. The payment reference or description. Limited to a maximum of 18 characters long.", "example": "Own Account Sweeping" }, "payee": { "$ref": "#/components/schemas/Payee" }, "payer": { "$ref": "#/components/schemas/HostedVrpPayerResponse" }, "refundAccount": { "$ref": "#/components/schemas/HostedVrpRefundAccount" }, "risk": { "$ref": "#/components/schemas/PaymentRisk" }, "paymentLifecycleId": { "type": "string", "description": "The Unique Identifier provided by TPP in the Payment request to identify the payment." }, "expectedExecutionTime": { "type": "string", "format": "date-time" }, "expectedSettlementTime": { "type": "string", "format": "date-time" }, "institutionPaymentId": { "type": "string" }, "statusDetails": { "$ref": "#/components/schemas/HostedPaymentStatusDetails" } } }, "ApiResponseOfCreateHostedVRPPaymentRequest": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/HostedVRPPaymentResponse" }, "tracingId": { "type": "string", "writeOnly": true } } }, "ApiResponseOfGetHostedVRPPaymentRequest": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/HostedVRPPaymentResponse" }, "tracingId": { "type": "string", "writeOnly": true } } }, "VRPSetupRequest": { "required": [ "payee" ], "type": "object", "properties": { "payer": { "$ref": "#/components/schemas/Payer" }, "payee": { "$ref": "#/components/schemas/Payee" }, "reference": { "type": "string", "description": "__Optional__. The payment reference or description. Limited to a maximum of 18 characters long.", "example": "Own Account Sweeping" }, "limits": { "$ref": "#/components/schemas/HostedVRPLimitsRequest" }, "validFrom": { "type": "string", "format": "date-time", "description": "__Optional__. Start date when the consent becomes valid." }, "validTo": { "type": "string", "format": "date-time", "description": "__Optional__. End date when the consent expires and becomes invalid." }, "recurringPaymentCategory": { "type": "string", "description": "The use-case for the VRP consent supported by the bank. Allowed values:
`ONGOING`
`SUBSCRIPTION`" }, "initialPayment": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "__Optional__. Initial payment to be charged under this consent. If enforced, this amount must match the first payment amount executed using this consent." }, "risk": { "$ref": "#/components/schemas/PaymentRisk" } } }, "VRPSetup": { "required": [ "payee" ], "type": "object", "properties": { "payer": { "$ref": "#/components/schemas/HostedVrpPayerResponse" }, "payee": { "$ref": "#/components/schemas/Payee" }, "reference": { "type": "string", "description": "__Optional__. The payment reference or description. Limited to a maximum of 18 characters long.", "example": "Own Account Sweeping" }, "limits": { "$ref": "#/components/schemas/HostedVRPLimits" }, "validFrom": { "type": "string", "format": "date-time", "description": "__Optional__. Start date when the consent becomes valid." }, "validTo": { "type": "string", "format": "date-time", "description": "__Optional__. End date when the consent expires and becomes invalid." }, "recurringPaymentCategory": { "type": "string", "description": "The use-case for the VRP consent supported by the bank. Allowed values:
`ONGOING`
`SUBSCRIPTION`" }, "initialPayment": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "__Optional__. Initial payment to be charged under this consent. If enforced, this amount must match the first payment amount executed using this consent." }, "risk": { "$ref": "#/components/schemas/PaymentRisk" } } }, "HostedVRPConsentRequestResponse": { "required": [ "id", "applicationId", "hostedUrl", "authToken", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Represents the Unique Id of the VRP consent request" }, "userId": { "type": "string", "format": "uuid", "description": "Represents the Unique Id for the `User` assigned by Yapily." }, "applicationUserId": { "type": "string", "description": "Represents the user-friendly reference to the `User`." }, "applicationId": { "type": "string", "format": "uuid", "description": "Represents the Unique Id of the `Application` the user is associated with." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiers" }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "redirectUrl": { "type": "string", "description": "URL of client's server to redirect the PSU after completion of the consent authorisation.", "example": "https://tpp-application.com" }, "vrpSetup": { "$ref": "#/components/schemas/VRPSetupRequest" }, "hostedUrl": { "type": "string", "description": "Represents the URL of Hosted UI page for the applicationId which initiates the user journey for the Consent.
URL would be appended with authToken, applicationId and userSettings." }, "authToken": { "type": "string", "description": "Represents the JWT Token signed by the certificate-vault using Yapily's keys." }, "createdAt": { "type": "string", "format": "date-time", "description": "Represents the date and time at which the Consent was created." }, "authorisationExpiresAt": { "type": "string", "format": "date-time", "description": "Represents the date and time at which the auth Token will expire." } } }, "GetHostedVRPConsentsResponse": { "type": "array", "items": { "required": [ "id", "applicationId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Represents the Unique Id of the VRP consent request" }, "applicationId": { "type": "string", "format": "uuid", "description": "Represents the Unique Id of the `Application` the user is associated with." }, "institutionIdentifiers": { "$ref": "#/components/schemas/InstitutionIdentifiers" }, "vrpSetup": { "$ref": "#/components/schemas/VRPSetupRequest" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Represents the date and time at which the Consent was updated." }, "consentStatus": { "type": "string", "description": "Current status of the authorisation. Can be one of [AWAITING_AUTHORIZATION, AUTHORIZED, REJECTED, REVOKED, FAILED, EXPIRED]" } } } }, "HostedVRPPhase": { "type": "object", "properties": { "phaseName": { "type": "string", "description": "The name of the hosted VRP consent process phase. Allowed values are : " }, "phaseCreatedAt": { "type": "string", "format": "date-time", "description": "The date and time at which the phase of the hosted Consent was created." } }, "description": "The phase of the VRP Consent Request." }, "PaymentRisk": { "type": "object", "description": "Additional information about the payment that may be used for risk scoring", "properties": { "contextType": { "$ref": "#/components/schemas/PaymentContextTypeV2" } } }, "HostedVRPLimitsRequest": { "type": "object", "description": "The restrictions and limits for payments executed under the VRP consent", "properties": { "periodicLimits": { "type": "array", "items": { "$ref": "#/components/schemas/HostedNonSweepingPeriodicLimits" } }, "maxAmountPerPayment": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "__Optional__. Max amount that can be submitted per payment." }, "maxCumulativeAmount": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "__Optional__. Max cumulative amount that can be submitted under this consent." }, "maxCumulativeNumberOfPayments": { "type": "integer", "format": "int32", "description": "__Optional__. Max number of payments that can be submitted under this consent." } } }, "HostedVRPLimits": { "type": "object", "description": "The restrictions and limits for payments executed under the VRP consent", "properties": { "periodicLimits": { "type": "array", "items": { "$ref": "#/components/schemas/HostedNonSweepingPeriodicLimits" } }, "maxAmountPerPayment": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "__Optional__. Max amount that can be submitted per payment." }, "maxCumulativeAmount": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "__Optional__. Max cumulative amount that can be submitted under this consent." }, "maxCumulativeNumberOfPayments": { "type": "integer", "format": "int32", "description": "__Optional__. Max number of payments that can be submitted under this consent." }, "editedByUser": { "type": "boolean", "description": "Indicates if the user edited the control parameters during authorisation" } } }, "HostedNonSweepingPeriodicLimits": { "required": [ "maxAmount", "frequency", "alignment" ], "type": "object", "properties": { "maxAmount": { "allOf": [ { "$ref": "#/components/schemas/Amount" } ], "description": "__Mandatory__. Maximum amount that can be specified in all payment instructions in a given period under this VRP consent. If the Alignment is Calendar, the limit is pro-rated in the first period to the remaining number of days." }, "frequency": { "type": "string", "description": "__Mandatory__. Frequency for which the payment limits are enforced. Allowed values are [MONTHLY]." }, "alignment": { "type": "string", "description": "__Mandatory__. Period alignment for which the payment limits are enforced. Allowed values are [CONSENT, CALENDAR]. If CONSENT, then period starts on consent creation date. If CALENDAR, then period lines up with the frequency e.g. WEEKLY period will begin at start of the week in question." } } }, "ApiListResponseOfPaymentConstraints": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentConstraintsResponse" } } }, "example": { "meta": { "tracingId": "661471ddb4344113a2d185b861cb3dcf" }, "data": [ { "institutionId": "mock-sandbox", "institutionCountryCode": "GB", "endpointPath": "/payments", "endpointMethod": "POST", "paymentType": "DOMESTIC_PAYMENT", "request": { "headers": { "title": "Header", "type": "object", "properties": { "psuID": { "title": "PSU Id", "type": "string", "description": "" } } }, "body": { "title": "Payment Request", "required": [ "payee", "amount", "paymentIdempotencyId", "type" ], "type": "object", "properties": { "paymentIdempotencyId": { "title": "Payment Idempotency Id", "pattern": "^.{1,35}$", "type": "string", "description": "Id for the payment" }, "type": { "enum": [ "DOMESTIC_PAYMENT" ], "title": "Payment Type", "type": "string", "description": "type of the payment" }, "contextType": { "default": "OTHER", "enum": [ "BILL", "GOODS", "SERVICES", "OTHER", "PERSON_TO_PERSON" ], "title": "Context Type", "type": "string", "description": "__Optional__. The payment context code. This defaults to `OTHER` if not specified." }, "reference": { "title": "Reference", "pattern": "^.{1,18}$", "type": "string", "description": "__Mandatory__. The payment reference or description. Limited to a maximum of 18 characters long.", "example": "Bill payment" }, "payee": { "title": "Payee", "required": [ "accountIdentifications", "name" ], "type": "object", "properties": { "name": { "title": "Name", "pattern": "^.{1,18}$", "type": "string", "description": "__Mandatory__. The account holder name of the beneficiary.", "example": "Jane Doe" }, "accountIdentifications": { "title": "Account Identifications", "type": "array", "items": { "required": [ "identification", "type" ], "type": "object", "properties": { "type": { "title": "Account Identification Type", "type": "string", "description": "__Mandatory__. Used to describe the format of the account.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/intro-to-payment-execution/#account-identifications-combinations) for more information on when to specify each type." }, "identification": { "title": "Account Identification", "type": "string", "description": "__Mandatory__. The value associated with the account identification type.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/intro-to-payment-execution/#account-identifications-combinations) for more information on the format of the values." } } }, "description": "__Mandatory__. The account identifications that identify the `Payee` bank account." }, "address": { "title": "Address", "type": "object", "properties": { "addressLines": { "title": "Address Lines", "type": "array", "items": { "title": "Address Line", "type": "string" }, "description": "__Optional__. The address line of the address" }, "streetName": { "title": "Street Name", "type": "string", "description": "__Optional__. The street name of the address" }, "buildingNumber": { "title": "Building Number", "type": "string", "description": "__Optional__. The building number of the address" }, "postCode": { "title": "Postcode", "type": "string", "description": "__Optional__. The post code of the address" }, "townName": { "title": "Town", "type": "string", "description": "__Optional__. The town name of the address" }, "county": { "title": "County", "type": "array", "items": { "type": "string" }, "description": "__Optional__. The list of counties for the address" }, "country": { "title": "Country", "type": "string", "description": "__Conditional__. The 2-letter country code for the address.

An `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment" }, "department": { "title": "Department", "type": "string", "description": "__Optional__. The department for the address" }, "subDepartment": { "title": "Sub-department", "type": "string", "description": "__Optional__. The sub-department for the address" }, "addressType": { "enum": [ "BUSINESS", "CORRESPONDENCE", "DELIVERY_TO", "MAIL_TO", "PO_BOX", "POSTAL", "RESIDENTIAL", "STATEMENT", "UNKNOWN" ], "title": "Address Type", "type": "string", "description": "__Optional__. The type of address" } }, "description": "__Conditional__. The address of the `Payee` or `Payer`." } }, "description": "__Mandatory__. Details of the beneficiary [person or business]." }, "payer": { "title": "Payer", "required": [ "accountIdentifications" ], "type": "object", "properties": { "accountIdentifications": { "title": "Account Identifications", "type": "array", "items": { "required": [ "identification", "type" ], "type": "object", "properties": { "type": { "enum": [ "IBAN" ], "title": "Account Identification Type", "type": "string", "description": "__Mandatory__. Should be IBAN only." }, "identification": { "title": "Account Identification", "pattern": "DE\\d{20}", "type": "string", "description": "__Mandatory__. The IBAN value associated with the account identity" } } }, "description": "__Mandatory__. The account identifications that identify the `Payer` bank account." }, "address": { "title": "Address", "type": "object", "properties": { "addressLines": { "title": "Address Lines", "type": "array", "items": { "title": "Address Line", "type": "string" }, "description": "__Optional__. The address line of the address" }, "streetName": { "title": "Street Name", "type": "string", "description": "__Optional__. The street name of the address" }, "buildingNumber": { "title": "Building Number", "type": "string", "description": "__Optional__. The building number of the address" }, "postCode": { "title": "Postcode", "type": "string", "description": "__Optional__. The post code of the address" }, "townName": { "title": "Town", "type": "string", "description": "__Optional__. The town name of the address" }, "county": { "title": "County", "type": "array", "items": { "type": "string" }, "description": "__Optional__. The list of counties for the address" }, "country": { "title": "Country", "type": "string", "description": "__Conditional__. The 2-letter country code for the address.

An `Institution` may require you to specify the `country` when used in the context of the `Payee` to be able to make a payment" }, "department": { "title": "Department", "type": "string", "description": "__Optional__. The department for the address" }, "subDepartment": { "title": "Sub-department", "type": "string", "description": "__Optional__. The sub-department for the address" }, "addressType": { "enum": [ "BUSINESS", "CORRESPONDENCE", "DELIVERY_TO", "MAIL_TO", "PO_BOX", "POSTAL", "RESIDENTIAL", "STATEMENT", "UNKNOWN" ], "title": "Address Type", "type": "string", "description": "__Optional__. The type of address" } }, "description": "__Conditional__. The address of the `Payee` or `Payer`." } } }, "amount": { "title": "Amount", "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "title": "Amount", "minimum": 0, "type": "number", "description": "__Mandatory__. The monetary value" }, "currency": { "title": "Currency", "pattern": "^[A-Z]{3,3}$", "type": "string", "description": "__Mandatory__. The [ISO 4217](https://www.xe.com/iso4217.php) currency code" } }, "description": "__Mandatory__. Monetary Amount." }, "paymentDateTime": { "type": "string", "description": "__Optional__, If present date should be greater than or equal to current date", "format": "date-time" } }, "description": "Domestic payment request schema" } } } ] } }, "PaymentConstraintsResponse": { "required": [ "institutionId", "institutionCountry", "paymentType", "request" ], "type": "object", "properties": { "institutionId": { "type": "string", "description": "The id to represent the `Institution`.", "example": "modelo-sandbox" }, "institutionCountryCode": { "type": "string", "description": "2 letter ISO Country code of the `Institution`.", "example": "GB" }, "endpointPath": { "type": "string", "description": "Define the applicable API end point." }, "endpointMethod": { "type": "string", "description": "Https Method for the endpoint." }, "paymentType": { "$ref": "#/components/schemas/PaymentTypeOfConstraints" }, "request": { "$ref": "#/components/schemas/RequestConstraints" } } }, "RequestConstraints": { "required": [ "body" ], "type": "object", "description": "Object defining the constraints rules applicable for a given requests.", "properties": { "headers": { "$ref": "#/components/schemas/Schema" }, "body": { "$ref": "#/components/schemas/Schema" } } }, "ApiListResponseOfDataConstraints": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataConstraintsResponse" } } }, "example": { "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.

See [Using a callback with an OTT (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-with-an-ott-optional) 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`.

See [Using a callback (Optional)](https://docs.yapily.com/pages/knowledge/yapily-concepts/callback_url/#using-a-callback-optional) 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](https://docs.yapily.com/pages/knowledge/open-banking/cbi_globe/).", "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.

**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.

**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.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/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.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/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).

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.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/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.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/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).

This 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.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/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.

See [Account Identification Combinations](https://docs.yapily.com/pages/key-concepts/payments/payment-execution/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).

This 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" } } } ] } }, "DataConstraintsResponse": { "required": [ "institutionId", "institutionCountry", "request" ], "type": "object", "properties": { "institutionId": { "type": "string", "description": "The id to represent the `Institution`.", "example": "modelo-sandbox" }, "institutionCountryCode": { "type": "string", "description": "2 letter ISO Country code of the `Institution`.", "example": "GB" }, "endpointPath": { "type": "string", "description": "Define the applicable API end point." }, "endpointMethod": { "type": "string", "description": "Https Method for the endpoint." }, "request": { "$ref": "#/components/schemas/RequestConstraints" } } }, "SchemaType": { "type": "string", "enum": [ "array", "boolean", "integer", "number", "object", "string" ] }, "Schema": { "type": "object", "properties": { "title": { "type": "string" }, "maximum": { "type": "number" }, "exclusiveMaximum": { "type": "number" }, "minimum": { "type": "number" }, "exclusiveMinimum": { "type": "number" }, "pattern": { "type": "string", "format": "regex" }, "maxItems": { "type": "integer", "minimum": 0 }, "minItems": { "type": "integer", "minimum": 0 }, "uniqueItems": { "type": "boolean" }, "required": { "type": "array", "items": { "type": "string" }, "minItems": 1, "uniqueItems": true }, "enum": { "type": "array", "items": { }, "minItems": 1, "uniqueItems": false }, "type": { "$ref": "#/components/schemas/SchemaType" }, "contains": { "$ref": "#/components/schemas/Schema" }, "not": { "$ref": "#/components/schemas/Schema" }, "if": { "$ref": "#/components/schemas/Schema" }, "then": { "$ref": "#/components/schemas/Schema" }, "else": { "$ref": "#/components/schemas/Schema" }, "allOf": { "type": "array", "items": { "$ref": "#/components/schemas/Schema" } }, "oneOf": { "type": "array", "items": { "$ref": "#/components/schemas/Schema" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/Schema" } }, "items": { "$ref": "#/components/schemas/Schema" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Schema" } }, "description": { "type": "string" }, "format": { "type": "string" }, "default": { }, "example": { }, "dependentRequired": { "description": "dependentRequired keyword is used to satisfy dependency between fields", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "uniqueItems": true, "default": [] } }, "$defs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Schema" } }, "$ref": { "type": "string" }, "x-yapily-annotations": { "type": "object", "properties": { "lastUpdatedAt": { "type": "string", "format": "date-time" } } }, "x-yapily-validations": { "type": "object", "properties": { "maxDurationFromNow": { "type": "string", "format": "duration" } } } }, "additionalProperties": false }, "ApplicationRequest": { "type": "object", "required": [ "name", "merchantCategoryCode", "ppcUserGroup", "isContractPresent" ], "properties": { "name": { "type": "string", "format": "^[a-zA-Z0-9 \\-_\\[\\]\\(\\)]+$", "description": "The name of the application" }, "merchantCategoryCode": { "type": "string", "format": "^\\d{4}$", "description": "The ISO-18245 merchant category code of the merchant the application is being created for.

Allowed values:", "example": "0742" }, "ppcUserGroup": { "type": "string", "description": "The payment user group from the purpose code list for the application.

Allowed values:", "example": "WHOLESALE_FI_FI" }, "callbackUrls": { "type": "array", "description": "The application callback URLs", "items": { "type": "string" } }, "isContractPresent": { "type": "boolean", "description": "Indicates if a contract is in place with the merchant and a KYB process has been completed" } } }, "ApplicationResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "The id of the application returned", "example": "2698db90-6635-4f76-b673-5ce8e2aeda0e" }, "rootApplicationId": { "type": "string", "format": "uuid", "description": "The id of the root application", "example": "eb25e1ee-f6af-4131-92fe-748e177bf950" }, "name": { "type": "string", "format": "^[a-zA-Z0-9 \\-_\\[\\]\\(\\)]+$", "description": "The name of the application" }, "merchantCategoryCode": { "type": "string", "format": "^\\d{4}$", "description": "The ISO-18245 merchant category code of the merchant the application is being created for.

Allowed values:", "example": "0742" }, "ppcUserGroup": { "type": "string", "description": "The payment user group from the purpose code list for the application.

Allowed values:", "example": "WHOLESALE_FI_FI" }, "callbackUrls": { "type": "array", "description": "The application callback URLs", "items": { "type": "string" } }, "isContractPresent": { "type": "boolean", "description": "Indicates if a contract is in place with the merchant and a KYB process has been completed" } } }, "ApiResponseOfApplicationResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "data": { "$ref": "#/components/schemas/ApplicationResponse" } } }, "ApiListOfApplicationResponse": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ApplicationResponseListMeta" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationResponse" } } } }, "ValidationError": { "required": [ "fieldName", "error" ], "properties": { "fieldName": { "type": "string", "format": "string", "description": "name of the field with error" }, "error": { "$ref": "#/components/schemas/EnumError" } } }, "EnumError": { "type": "string", "enum": [ "MANDATORY", "INVALID_FORMAT" ] }, "ValidationErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } } } }, "VrpConfiguration": { "properties": { "maximumIndividualAmount": { "description": "Maximum amount per transaction", "allOf": [ { "$ref": "#/components/schemas/Amount" } ] }, "maximumCumulativeAmount": { "description": "Maximum cumulative amount", "allOf": [ { "$ref": "#/components/schemas/Amount" } ] }, "maximumCumulativeNumberOfPayments": { "description": "Maximum cumulative number of payments", "type": "integer", "minimum": 0 }, "periodicLimits": { "type": "array", "items": { "$ref": "#/components/schemas/VrpPeriodicLimit" }, "minItems": 1 }, "recurringPaymentCategory": { "description": "Payment Category with allowed values: ONGOING, SUBSCRIPTION", "type": "string", "example": "ONGOING" } } }, "VrpPeriodicLimit": { "required": [ "maximumAmount", "frequency", "alignment" ], "properties": { "maximumAmount": { "description": "__Mandatory__. Maximum amount that can be specified in all payment instructions in a given period under this VRP consent. If the Alignment is Calendar, the limit is pro-rated in the first period to the remaining number of days.", "allOf": [ { "$ref": "#/components/schemas/Amount" } ] }, "frequency": { "$ref": "#/components/schemas/FrequencyEnum" }, "alignment": { "$ref": "#/components/schemas/AlignmentEnum" } } }, "FrequencyEnum": { "type": "string", "description": "__Mandatory__. Frequency for which the payment limits are enforced. Allowed values are [MONTHLY].", "enum": [ "MONTHLY" ] }, "AlignmentEnum": { "type": "string", "description": "__Mandatory__. Period alignment for which the payment limits are enforced. Allowed values are [CONSENT, CALENDAR]. If CONSENT, then period starts on consent creation date. If CALENDAR, then period lines up with the frequency e.g. WEEKLY period will begin at start of the week in question.", "enum": [ "CONSENT", "CALENDAR" ] }, "WebhookMetadata": { "type": "object", "description": "Any data (under 10kB total) that should be associated with the Webhook. A copy of this data will be returned on every Webhook trigger.", "additionalProperties": { "type": "string" } }, "Metadata": { "type": "object", "properties": { "tracingId": { "type": "string", "format": "uuid", "description": "yapily tracing id" } } }, "WebhookDetailsWithSecret": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "data": { "allOf": [ { "$ref": "#/components/schemas/RegisteredWebhookWithStatus" }, { "type": "object", "properties": { "webhookSecret": { "type": "string", "description": "HMAC secret needed to validate that the request payload is genuine" } } } ] } } }, "RegisteredWebhookWithStatus": { "allOf": [ { "$ref": "#/components/schemas/RegisteredWebhook" }, { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/WebhookStatusType" } } } ] }, "WebhookStatusType": { "type": "string", "enum": [ "active", "paused" ] }, "RegisteredWebhook": { "type": "object", "properties": { "id": { "type": "string", "description": "This webhook's ID, used to update or remove the webhook", "format": "uuid" }, "applicationId": { "type": "string", "format": "uuid" }, "categories": { "type": "array", "items": { "type": "string", "description": "One or more event categories for which the webhook will be triggered" } }, "callbackUrl": { "type": "object", "description": "Callback URLs where events will be sent", "properties": { "main": { "type": "object", "description": "Primary URL where events will be sent", "properties": { "url": { "type": "string" } } }, "backup": { "type": "object", "description": "Secondary URL where events will be sent whenever the primary URL is not responding", "properties": { "url": { "type": "string" } } } } }, "metadata": { "$ref": "#/components/schemas/WebhookMetadata" } } }, "CategoryStructure": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } }, "ApiResponseOfGetCategorisedTransactionsRequest": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "tracingId": { "type": "string" }, "count": { "type": "integer", "description": "Total number of categorised transactions available" }, "pageCount": { "type": "integer", "description": "Total number of pages available, calculated based on the limit per page sent in the request." } } }, "data": { "type": "object", "required": [ "transactions" ], "properties": { "transactions": { "type": "array", "items": { "type": "object", "required": [ "enrichment", "date", "description", "transactionAmount" ], "properties": { "enrichment": { "type": "object", "description": "Enrichment/Categorisation data", "required": [ "transactionHash", "categorisation" ], "properties": { "transactionHash": { "type": "object", "description": "A unique identifier for the transaction that was generated by Yapily. It is a hash of some transaction attributes that is useful when no other identifier is present for instance.", "required": [ "hash" ], "properties": { "hash": { "type": "string" } } }, "categorisation": { "type": "object", "description": "Categories associated with the transaction (see [categories list](https://docs.yapily.com/pages/data/data-plus/categorisation-list-of-categories/))", "required": [ "categories" ], "properties": { "categories": { "type": "array", "items": { "type": "string" } } } }, "merchant": { "type": "object", "description": "Processed merchant information", "properties": { "id": { "type": "string", "description": "The unique identifier for the merchant" }, "name": { "type": "string", "description": "The familiar name of the merchant (eg. 'Waitrose', 'Uber')" }, "logo": { "type": "string", "description": "The logo of the merchant, formatted as a URL" } } } } }, "recurrence": { "type": "string", "description": "Processed type of recurrence for the transaction (eg. 'one off', 'subscription')" }, "paymentProcessor": { "type": "string", "description": "Processed payment provider for the transaction (eg. 'PayPal')" }, "location": { "type": "string", "description": "Processed location of the transaction/merchant derived from the transaction's description, formatted as an address" }, "merchant": { "type": "object", "description": "Generic merchant information", "properties": { "merchantCategoryCode": { "type": "string", "description": "An ISO 18245 code specifying the goods and services that the merchant provides (eg. `5411` for Grocery Stores and Supermarkets)" } } }, "id": { "type": "string", "description": "__Conditional.__ An identifier for the transaction retrieved from Yapily AIS (ie. present when using [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation))" }, "date": { "type": "string", "format": "date-time", "description": "The date and time when the transaction happened" }, "description": { "type": "string", "description": "The description associated with the transaction" }, "transactionAmount": { "type": "object", "description": "The amount associated with the transaction", "required": [ "amount", "currency" ], "properties": { "amount": { "type": "number", "description": "The monetary amount (a positive value implies _incoming_ transaction and a negative value implies _outgoing_ transaction)" }, "currency": { "type": "string", "description": "The [ISO 4217](https://www.xe.com/iso4217.php) currency code" } } }, "bookingDateTime": { "type": "string", "format": "date-time", "description": "__Conditional.__ The date and time when the transaction was booked
This may be present when using [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation)" }, "valueDateTime": { "type": "string", "format": "date-time", "description": "__Conditional.__ The date and time when the funds either cease to be available (for _outgoing_ transactions) or become available to the account owner (for _incoming_ transactions)
This may be present when using [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation)" }, "status": { "type": "string", "description": "__Conditional.__ The status of the transaction. Enum: BOOKED, PENDING
This may be present when using [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation)" }, "amount": { "type": "number", "description": "__Conditional.__ The monetary amount (a positive value implies _incoming_ transaction and a negative value implies _outgoing_ transaction)
This may be present when using [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation)" }, "currency": { "type": "string", "description": "__Conditional.__ The [ISO 4217](https://www.xe.com/iso4217.php) currency code
This may be present when using [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation)" }, "reference": { "type": "string", "description": "__Conditional.__ The reference associated with the transaction
This may be present when using [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation)" }, "transactionInformation": { "type": "array", "description": "__Conditional.__ Other details associated with the transaction. This is narrative data, caught as unstructured text.
This may be present when using [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation)", "items": { "type": "string" } }, "proprietaryBankTransactionCode": { "type": "object", "description": "__Conditional.__ A transaction code that is proprietary to the issuer institution
This may be present when using [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation)", "properties": { "code": { "type": "string" }, "issuer": { "type": "string" } } }, "isoBankTransactionCode": { "type": "object", "description": "__Conditional.__ The ISO 20022 codes specifying the type of the transaction (eg. domain of 'Payments', family of 'Issued Credit Transfers', and sub-family of 'Domestic Credit Transfer')
This may be present when using [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation)", "properties": { "domainCode": { "type": "object", "description": "The domain of the transaction", "properties": { "code": { "type": "string", "description": "Unique identifier of the ISO code" }, "name": { "type": "string", "description": "Name of the ISO code" } } }, "familyCode": { "type": "object", "description": "The family of the transaction", "properties": { "code": { "type": "string", "description": "Unique identifier of the ISO code" }, "name": { "type": "string", "description": "Name of the ISO code" } } }, "subFamilyCode": { "type": "object", "description": "The sub-family of the transaction", "properties": { "code": { "type": "string", "description": "Unique identifier of the ISO code" }, "name": { "type": "string", "description": "Name of the ISO code" } } } } }, "balance": { "type": "object", "description": "__Conditional.__ The account balance around the time of the transaction (the exact timing is dictated by the balance type)
This may be present when using [Transactions and Categorisation endpoint](https://docs.yapily.com/api/reference/#operation/post-accounts-accountId-transactions-categorisation)", "properties": { "type": { "type": "string", "description": "Enum: CLOSING_AVAILABLE, CLOSING_BOOKED, CLOSING_CLEARED, EXPECTED, FORWARD_AVAILABLE, INFORMATION, INTERIM_AVAILABLE, INTERIM_BOOKED, INTERIM_CLEARED, OPENING_AVAILABLE, OPENING_BOOKED, OPENING_CLEARED, PREVIOUSLY_CLOSED_BOOKED, AUTHORISED, OTHER, UNKNOWN" }, "balanceAmount": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" } } } } } } } } } }, "links": { "type": "object", "properties": { "first": { "type": "string" }, "prev": { "type": "string" }, "self": { "type": "string" }, "next": { "type": "string" }, "last": { "type": "string" } } } } }, "ApiResponseOfCreateTransactionsCategorisationRequest": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "tracingId": { "type": "string" } } }, "data": { "type": "object", "properties": { "categorisationId": { "type": "string", "format": "uuid" } } } } }, "ApplicationUserPatchRequest": { "type": "object", "required": [ "op", "path", "value" ], "properties": { "op": { "$ref": "#/components/schemas/PatchOperation" }, "path": { "description": "The path to the target location.", "type": "string" }, "value": { "description": "The value to be replaced or tested.", "type": "string" } } }, "PatchOperation": { "type": "string", "description": "The operation to be performed", "enum": [ "add", "replace" ] } }, "securitySchemes": { "basicAuth": { "description": "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](https://console.yapily.com/).

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.", "scheme": "basic", "type": "http" } }, "examples": { "bulk-payment-details-by-id-response": { "value": { "meta": { "tracingId": "27b47dca-fb0f-4448-b470-1cd2d5516d0f" }, "data": { "id": "e75d2c85-08e9-4a48-8d14-f789186f2a19", "consentId": "5daeb980-5ff5-49db-b7a0-e93dd9c93533", "payments": [ { "id": "payment-w1", "status": "COMPLETED" }, { "id": "payment-w2", "status": "FAILED", "statusDetails": { "code": "B001", "reason": "Payment has been rejected" } }, { "id": "payment-w3", "status": "COMPLETED" } ] } } }, "berlin-group-example-acc-auth-request": { "description": "Berlin Group Example Request", "value": { "applicationUserId": "string", "institutionId": "n26" } }, "berlin-group-example-embedded-acc-auth-request": { "description": "Berlin Group Example Request", "value": { "applicationUserId": "string", "institutionId": "fiducia-sandbox", "userCredentials": { "id": "6154057725", "password": "PISPWD12" } } }, "berlin-group-sca-code-example-request": { "description": "Berlin Group (SCA Code) Example Request", "value": { "applicationUserId": "string", "institutionId": "fiducia-sandbox", "scaCode": "6154057725" } }, "berlin-group-selected-sca-method-example-request": { "description": "Berlin Group (Selected SCA Method) Example Request", "value": { "applicationUserId": "string", "institutionId": "fiducia-sandbox", "selectedScaMethod": { "id": "944", "type": "PUSH_OTP", "description": "SecureSIGN", "information": "Bitte bestätigen Sie den Vorgang in Ihrer SecureGo plus App" } } }, "berlin-group-eur-embedded-bulk-payment-example-request": { "description": "Berlin Group EUR Embedded Bulk Payment Example Request", "value": { "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.00, "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.00, "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-request": { "description": "Berlin Group EUR Embedded Bulk Payment (SCA Code) Example Request", "value": { "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.00, "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.00, "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-single-domestic-payment-example-request": { "description": "Berlin Group EUR Single Domestic Payment Example Request", "value": { "applicationUserId": "string", "institutionId": "n26", "paymentRequest": { "paymentIdempotencyId": "234g87t58tgeuo848wudjew489", "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "IBAN", "identification": "DE12345678901234567890" } ] }, "amount": { "amount": 1.00, "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-embedded-payment-example-request": { "description": "Berlin Group EUR Single Domestic Payment Example Request", "value": { "applicationUserId": "string", "institutionId": "postbank-sandbox", "userCredentials": { "id": "6154057725", "password": "PISPWD12" }, "paymentRequest": { "type": "DOMESTIC_PAYMENT", "paymentIdempotencyId": "e4f913909a3d11eabb370242ac130002", "reference": "REFERENCE", "amount": { "amount": 1.00, "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-request": { "description": "Berlin Group EUR Single Domestic Payment (SCA Code) Example Request", "value": { "applicationUserId": "string", "institutionId": "postbank-sandbox", "scaCode": "325614", "paymentRequest": { "type": "DOMESTIC_PAYMENT", "paymentIdempotencyId": "e4f913909a3d11eabb370242ac130002", "reference": "REFERENCE", "amount": { "amount": 1.00, "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-selected-sca-method-example-request": { "description": "Berlin Group EUR Single Domestic Payment (Selected SCA Method) Example Request", "value": { "applicationUserId": "string", "institutionId": "postbank-sandbox", "selectedScaMethod": { "id": "591655" }, "paymentRequest": { "type": "DOMESTIC_PAYMENT", "paymentIdempotencyId": "e4f913909a3d11eabb370242ac130002", "reference": "REFERENCE", "amount": { "amount": 1.00, "currency": "EUR" }, "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "IBAN", "identification": "DE12345678901234567890" } ] }, "payee": { "name": "Jane Doe", "address": { "country": "DE" }, "accountIdentifications": [ { "type": "IBAN", "identification": "DE09876543210987654321" } ] } } } }, "obie-example-acc-auth-request": { "description": "OBIE Example Request", "value": { "applicationUserId": "string", "institutionId": "modelo-sandbox", "callback": "https://display-parameters.com/" } }, "eur-single-domestic-payment-auth-example-request": { "description": "EUR Single Domestic Example Request", "value": { "applicationUserId": "string", "institutionId": "bpm-sandbox", "callback": "https://display-parameters.com/", "paymentRequest": { "paymentIdempotencyId": "234g87t58tgeuo848wudjew489", "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "IBAN", "identification": "DE12345678901234567890" } ] }, "amount": { "amount": 1.00, "currency": "EUR" }, "reference": "Bill Payment", "type": "DOMESTIC_PAYMENT", "payee": { "name": "Jane Doe", "address": { "country": "BE" }, "accountIdentifications": [ { "type": "IBAN", "identification": "BE12345678901234" } ] } } } }, "gbp-single-domestic-payment-auth-example-request": { "description": "GBP Single Domestic Example Request", "value": { "applicationUserId": "string", "institutionId": "modelo-sandbox", "callback": "https://display-parameters.com/", "paymentRequest": { "paymentIdempotencyId": "4289457hd38djoa783jw9qag3", "amount": { "amount": 1.00, "currency": "GBP" }, "reference": "Bill Payment", "contextType": "BILL_IN_ARREARS", "purposeCode": "COMT", "type": "DOMESTIC_PAYMENT", "payee": { "name": "Jane Doe", "address": { "country": "GB" }, "accountIdentifications": [ { "type": "SORT_CODE", "identification": "123456" }, { "type": "ACCOUNT_NUMBER", "identification": "12345678" } ], "accountType": "BUSINESS_SAVING" } } } }, "eur-domestic-single-payment-example-request": { "description": "EUR Domestic Single Payment Example Request", "value": { "paymentIdempotencyId": "234g87t58tgeuo848wudjew489", "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "IBAN", "identification": "DE12345678901234567890" } ] }, "amount": { "amount": 1.00, "currency": "EUR" }, "reference": "Bill Payment", "type": "DOMESTIC_PAYMENT", "payee": { "name": "Jane Doe", "address": { "country": "BE" }, "accountIdentifications": [ { "type": "IBAN", "identification": "BE12345678901234" } ] } } }, "gbp-domestic-single-payment-example-request": { "description": "GBP Domestic Single Payment Example Request", "value": { "paymentIdempotencyId": "4289457hd38djoa783jw9qag3", "amount": { "amount": 1.00, "currency": "GBP" }, "reference": "Bill Payment", "contextType": "BILL_IN_ARREARS", "purposeCode": "COMT", "type": "DOMESTIC_PAYMENT", "payee": { "name": "Jane Doe", "address": { "country": "GB" }, "accountIdentifications": [ { "type": "SORT_CODE", "identification": "123456" }, { "type": "ACCOUNT_NUMBER", "identification": "12345678" } ], "accountType": "BUSINESS_SAVING" } } }, "uk-bulk-payment-example-request": { "description": "UK Bulk Payment Example Request", "value": { "idempotencyId": "1cc3e60d-5500-42be-aaeb-3c5e2f5ed048", "payments": [ { "type": "DOMESTIC_PAYMENT", "paymentIdempotencyId": "d78fy48uh8f9odhde68dfi38di9", "reference": "payment1", "contextType": "BILL_IN_ARREARS", "purposeCode": "COMT", "amount": { "amount": 2.00, "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", "amount": { "amount": 5.00, "currency": "GBP" }, "payee": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "87654321" }, { "type": "SORT_CODE", "identification": "654321" } ] } } ] } }, "uk-bulk-payment-auth-example-request": { "description": "UK Bulk Payment Example Request", "value": { "applicationUserId": "string", "institutionId": "modelo-sandbox", "callback": "https://display-parameters.com/", "paymentRequest": { "payments": [ { "type": "DOMESTIC_PAYMENT", "paymentIdempotencyId": "d78fy48uh8f9odhde68dfi38di9", "reference": "payment1", "contextType": "BILL_IN_ARREARS", "purposeCode": "COMT", "amount": { "amount": 2.00, "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.00, "currency": "GBP" }, "payee": { "name": "John Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "87654321" }, { "type": "SORT_CODE", "identification": "654321" } ], "accountType": "BUSINESS_SAVING" } } ] } } }, "cbi-globe-pis-pre-auth-example-request": { "description": "CBI Globe (PIS) example request", "value": { "applicationUserId": "string", "institutionId": "n26", "callback": "https://display-parameters.com/", "scope": "PIS", "reference": "Bill Payment", "amount": { "amount": 1.00, "currency": "EUR" }, "payee": { "name": "Jane Doe", "country": "BE", "accountIdentifications": [ { "type": "IBAN", "identification": "BE12345678901234" } ] }, "payer": { "accountIdentifications": [ { "type": "IBAN", "identification": "DE12345678901234567890" } ] } } }, "berlin-group-ais-pre-auth-example-request": { "description": "Berlin Group (AIS) Example Request", "value": { "applicationUserId": "string", "institutionId": "n26", "callback": "https://display-parameters.com/", "scope": "AIS" } }, "berlin-group-pis-pre-auth-example-request": { "description": "Berlin Group (PIS) Example Request", "value": { "applicationUserId": "string", "institutionId": "n26", "callback": "https://display-parameters.com/", "scope": "PIS" } }, "berlin-group-eur-single-domestic-embedded-payment-example-response": { "description": "Berlin Group EUR Single Domestic Payment Example Response", "value": { "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" } ] } } }, "berlin-group-sca-code-example-response": { "description": "Berlin Group (SCA Code) Example Response", "value": { "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" } } }, "berlin-group-selected-sca-method-example-response": { "description": "Berlin Group (Selected SCA Method) Example Response", "value": { "meta": { "tracingId": "eaa703f3869b46b18732fa0de60f6073" }, "data": { "id": "149da283-2958-4128-9d72-e3a02e8bb83d", "userUuid": "6b082877-b137-4743-bba3-07b6a8148b42", "applicationUserId": "string", "institutionId": "fiducia-sandbox", "status": "AWAITING_SCA_CODE", "createdAt": "2021-06-09T11:47:24.513Z", "expiresAt": "2021-09-07T00:00:00Z", "timeToExpire": "P89DT12H6M39.998S", "featureScope": [ "ACCOUNT_TRANSACTIONS", "ACCOUNTS", "ACCOUNT", "ACCOUNT_BALANCES" ], "state": "c99f35c118194737b83487a0e6a48ed9", "institutionConsentId": "4514274319060120226PSDLT-BL-LB002045CO9545RW", "selectedScaMethod": { "id": "942", "type": "SMS_OTP", "description": "mobile TAN" } } } }, "berlin-group-multiple-sca-methods-example-response": { "description": "Berlin Group (Multiple SCA Methods) Example Response", "value": { "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" } ] } } }, "berlin-group-single-sca-method-example-response": { "description": "Berlin Group (Single SCA Method) Example Response", "value": { "meta": { "tracingId": "1565f7e13a0b4bf6b312cf8cc5747c7c" }, "data": { "id": "66c8c0f2-1678-4404-a68f-2236a1afcdad", "userUuid": "6b082877-b137-4743-bba3-07b6a8148b42", "applicationUserId": "string", "institutionId": "fiducia-sandbox", "status": "AWAITING_SCA_CODE", "createdAt": "2021-06-09T11:49:18.815Z", "expiresAt": "2021-09-07T00:00:00Z", "timeToExpire": "P89DT12H10M41.167S", "featureScope": [ "ACCOUNT_TRANSACTIONS", "ACCOUNTS", "ACCOUNT", "ACCOUNT_BALANCES" ], "state": "3fb4024282d0432cb710094c4c723ae5", "institutionConsentId": "1448194319060120228PSDLT-BL-LB002045CO9545RW", "scaMethods": [ { "id": "944", "type": "PUSH_OTP", "description": "SecureSIGN" } ], "selectedScaMethod": { "id": "944", "type": "PUSH_OTP", "description": "SecureSIGN" } } } }, "berlin-group-eur-single-domestic-payment-example-response": { "description": "Berlin Group EUR Single Domestic Payment Example Response", "value": { "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" } } }, "berlin-group-eur-single-domestic-payment-sca-code-example-response": { "description": "Berlin Group EUR Single Domestic Payment (SCA Code) Example Response", "value": { "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" } } }, "berlin-group-eur-single-domestic-payment-selected-sca-method-example-response": { "description": "Berlin Group EUR Single Domestic Payment (Selected SCA Method) Example Response", "value": { "meta": { "tracingId": "f69f66322b4b482c93099a206d9f003e" }, "data": { "id": "1767d386-c20a-4136-a311-0a455dd41a78", "userUuid": "95f71ebc-c8ae-4e25-aded-86e9bbd62966", "applicationUserId": "string", "institutionId": "postbank-sandbox", "state": "048a1187a9324652bedb6a653211a8a3", "status": "AWAITING_SCA_CODE", "createdAt": "2021-01-25T18:32:23.933Z", "featureScope": [ "CREATE_DOMESTIC_SINGLE_PAYMENT", "EXISTING_PAYMENT_INITIATION_DETAILS", "EXISTING_PAYMENTS_DETAILS" ], "selectedScaMethod": { "id": "591655", "information": "1. Stecken Sie Ihre Chipkarte in den TAN-Generator und drücken \"F\".
2. Halten Sie den TAN-Generator an die animierte Grafik. Dabei müssen die Markierungen
(Dreiecke) der Grafik mit denen auf Ihrem TAN-Generator übereinstimmen.
3. Prüfen Sie die Anzeige auf dem Leserdisplay und drücken \"OK\".
4. Prüfen Sie die Hinweise
\"Empfänger-IBAN\" und \"Betrag\"
auf dem Leserdisplay und bestätigen Sie diese dann jeweils mit \"OK\" auf Ihrem TAN-Generator.

5. Bitte beachten: Überprüfen Sie die Anzeige des TAN-Generators immer anhand der Original-Transaktions-Daten - z.B. einer Rechnung.
Bitte geben Sie die auf Ihrem TAN-Generator angezeigte TAN hier ein und bestätigen Sie diese.", "data": [ "0488701109982928CY4390400001000010000520,00" ] } } } }, "berlin-group-eur-embedded-bulk-payment-example-response": { "description": "Berlin Group EUR Embedded Bulk Payment Example Response", "value": { "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" } } } }, "berlin-group-eur-embedded-bulk-payment-sca-code-example-response": { "description": "Berlin Group EUR Embedded Bulk Payment (SCA Code) Example Response", "value": { "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" } } }, "berlin-group-pis-pre-auth-example-response": { "description": "Berlin Group Example (PIS) Response", "value": { "meta": { "tracingId": "ba79c56773de42129dbf8164b202276c" }, "data": { "id": "53ff00d0-91dd-417d-880b-cdd7c50090ed", "userUuid": "e2578545-27a4-4edf-983f-5d33c2d7b559", "applicationUserId": "string", "institutionId": "n26", "state": "4399535ee4de46238fce108a95669848", "status": "AWAITING_PRE_AUTHORIZATION", "createdAt": "2021-06-10T09:54:46.669Z", "featureScope": [ "INITIATE_ONETIME_PRE_AUTHORISATION_PAYMENTS" ], "authorisationUrl": "https://app.n26.com/open-banking?requestId=2e2b2efd-82bb-4a2b-8f67-ced1a93511b8&state=4399535ee4de46238fce108a95669848&authType=XS2A&scope=DEDICATED_PISP", "qrCodeUrl": "https://images.yapily.com/image/7384ad3b-5eb1-4304-9cfa-7aa6fcc5e0c7/1623318888?size=0" } } }, "berlin-group-example-ais-pre-auth-response": { "description": "Berlin Group Example (AIS) Response", "value": { "meta": { "tracingId": "8acb66e6a9e142e79acc3ccf6cc03e04" }, "data": { "id": "73064bb9-c84d-4242-897c-4150aacfa658", "userUuid": "e2578545-27a4-4edf-983f-5d33c2d7b559", "applicationUserId": "string", "institutionId": "n26", "state": "1575102ed5664761bce34927f0caa50f", "status": "AWAITING_PRE_AUTHORIZATION", "createdAt": "2021-05-11T13:03:43.619Z", "featureScope": [ "INITIATE_PRE_AUTHORISATION" ], "authorisationUrl": "https://app.n26.com/open-banking?requestId=9ae856ce-6b10-4956-8da8-c66ee0c9d86f&state=1575102ed5664761bce34927f0caa50f&authType=XS2A&scope=DEDICATED_AISP", "qrCodeUrl": "https://images.yapily.com/image/f86d382b-c00a-4650-8d0d-9ee6ba1093cd/1620738225?size=0" } } }, "example-acc-balance-response": { "description": "Example response", "value": { "meta": { "tracingId": "82e86ae9547a4f04b3773c1207e4b84d" }, "data": { "mainBalanceAmount": { "amount": -3.07920860411E9, "currency": "EUR" }, "balances": [ { "type": "INTERIM_AVAILABLE", "balanceAmount": { "amount": -3.07920860411E9, "currency": "EUR" } }, { "type": "AUTHORISED", "balanceAmount": { "amount": -3.07920860411E9, "currency": "EUR" } } ] } } }, "obie-example-acc-auth-response-post": { "description": "OBIE Example Response", "value": { "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", "authorisationUrl": "https://ob19-auth1-ui.o3bank.co.uk/auth?client_id=e7f6b95b-5f35-419b-b301-8b08bcd946de&response_type=code+id_token&state=7948ba4d6a064001b06ef28f8c06ca4a&nonce=7948ba4d6a064001b06ef28f8c06ca4a&scope=openid+accounts&redirect_uri=https%3A%2F%2Fauth.yapily.com%2F&request=eyJraWQiOiJnRTRvU3VaZDl4TVpUNXZDdTNWYy1mdktNak0iLCJhbGciOiJQUzI1NiJ9.eyJhdWQiOiJodHRwczovL29iMTktYXV0aDEtdWkubzNiYW5rLmNvLnVrIiwic2NvcGUiOiJvcGVuaWQgYWNjb3VudHMiLCJpc3MiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJjbGllbnRfaWQiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJyZXNwb25zZV90eXBlIjoiY29kZSBpZF90b2tlbiIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOi8vYXV0aC55YXBpbHkuY29tLyIsInN0YXRlIjoiNzk0OGJhNGQ2YTA2NDAwMWIwNmVmMjhmOGMwNmNhNGEiLCJjbGFpbXMiOnsiaWRfdG9rZW4iOnsiYWNyIjp7InZhbHVlIjoidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoiYWFjLTBhNzQzYTBmLTBiN2QtNGU3Yi04N2ViLTBiYzY1ZTFkMmY5NyIsImVzc2VudGlhbCI6dHJ1ZX19LCJ1c2VyaW5mbyI6eyJvcGVuYmFua2luZ19pbnRlbnRfaWQiOnsidmFsdWUiOiJhYWMtMGE3NDNhMGYtMGI3ZC00ZTdiLTg3ZWItMGJjNjVlMWQyZjk3IiwiZXNzZW50aWFsIjp0cnVlfX19LCJub25jZSI6Ijc5NDhiYTRkNmEwNjQwMDFiMDZlZjI4ZjhjMDZjYTRhIiwianRpIjoiNTIxNGFjNTQtNTEzYi00N2Y1LTgyYjUtZWExY2NhYzg0YzNiIiwiaWF0IjoxNjIzMjI1ODAxLCJleHAiOjE2MjMyMjc2MDF9.wmNfzJD1ekN_f028qWOyVvICkFm2uJ5Umok4hmxk4HZnDY2AOWDg4VX_MJjPHDydhfW8ZciBfCbEgmnButmASBbil-tHzwDIholS4RmnOZ4DXD-AttYx_VA2_X36J53kmlCHstPZpoawSIzdcnyW0JIhmVEvs5ZsaJvsDKhWk0hgYNS2GI0PORcn85W98EaE8APVrsz-tR-EfC9NmSZu7tH1zLyyD43AuD2BqdlMiYVTlzZsJ3FGPZ-ddT0rRloJvxPV6GLibjNAEowpSLjmDLv2v7gWszmYgcrzp5UM2jllfVL2KPA6Be5Eg6LVkL60Q3FKQyOMc8SCAWhALq_7Ew", "qrCodeUrl": "https://images.yapily.com/image/3b634d3c-a2ce-49b8-9014-330661800604/1623225801?size=0" } } }, "obie-example-acc-auth-response-put": { "description": "OBIE Example Response", "value": { "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" ] } } }, "obie-example-acc-auth-response-patch": { "description": "OBIE Example Response", "value": { "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", "authorisationUrl": "https://ob19-auth1-ui.o3bank.co.uk/auth?client_id=e7f6b95b-5f35-419b-b301-8b08bcd946de&response_type=code+id_token&state=0623e536c5044b4aa3f6c66e7537bee0&nonce=0623e536c5044b4aa3f6c66e7537bee0&scope=openid+accounts&redirect_uri=https%3A%2F%2Fauth.yapily.com%2F&request=eyJraWQiOiJnRTRvU3VaZDl4TVpUNXZDdTNWYy1mdktNak0iLCJhbGciOiJQUzI1NiJ9.eyJhdWQiOiJodHRwczovL29iMTktYXV0aDEtdWkubzNiYW5rLmNvLnVrIiwic2NvcGUiOiJvcGVuaWQgYWNjb3VudHMiLCJpc3MiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJjbGllbnRfaWQiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJyZXNwb25zZV90eXBlIjoiY29kZSBpZF90b2tlbiIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOi8vYXV0aC55YXBpbHkuY29tLyIsInN0YXRlIjoiMDYyM2U1MzZjNTA0NGI0YWEzZjZjNjZlNzUzN2JlZTAiLCJjbGFpbXMiOnsiaWRfdG9rZW4iOnsiYWNyIjp7InZhbHVlIjoidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoiYWFjLWY3ODQ3ZTk5LTdjNjYtNGJiOC04NjQxLTYxYTI0MDU3ZjJlOCIsImVzc2VudGlhbCI6dHJ1ZX19LCJ1c2VyaW5mbyI6eyJvcGVuYmFua2luZ19pbnRlbnRfaWQiOnsidmFsdWUiOiJhYWMtZjc4NDdlOTktN2M2Ni00YmI4LTg2NDEtNjFhMjQwNTdmMmU4IiwiZXNzZW50aWFsIjp0cnVlfX19LCJub25jZSI6IjA2MjNlNTM2YzUwNDRiNGFhM2Y2YzY2ZTc1MzdiZWUwIiwianRpIjoiMjEyM2E1OGMtMTExYi00OGY2LTg2ODAtZTViYTNiMzI3MjM5IiwiaWF0IjoxNjIzMjI3MDAxLCJleHAiOjE2MjMyMjg4MDF9.JG5lc5TWjCucWZPfcyd34trk0QcGNzhYXfhHTlVrcfu1zjrAtSUI8i0o4yKqS19cOGKHq1HtuQac2hhO8gCr_vd5n7eIuIrWfjEM1MuIwsJ85jOpMBkEiSOurLRIgW77VmqHpVUVj5-0-1Tk-N-vaC_4nIdtSi576sOb4rjLQvs2EX_sFODGjyMxHXiZlnr2p71gA3nRy8M2Vv_At4-NPW8OLULS8zXclWoK797HFAGtsNLCy8tz0YCsnEaFhcLhZSliy3a7DRfxvBmIzhY23M4uQ6bpM1zCyqTPsOhqR-qdgnZorBrax_2CQ37yIeV4becUJWvZSdnjYX7gDtNltA", "qrCodeUrl": "https://images.yapily.com/image/4ef6e16c-dbe2-4d90-9e1b-868d946082ef/1623227001?size=0" } } }, "obie-example-accounts-response": { "description": "OBIE Example Response", "value": { "meta": { "tracingId": "1139346006be4345a94fd8b3728844e3", "count": 1 }, "data": [ { "id": "700004000000000000000002", "type": "Personal - Current", "balance": -12.57, "currency": "GBP", "usageType": "PERSONAL", "accountType": "CURRENT", "nickname": "xxxx0006", "accountNames": [ { "name": "Mr. Roberto Rastapopoulos & Ivan Sakharine" } ], "accountIdentifications": [ { "type": "SORT_CODE", "identification": "700001" }, { "type": "ACCOUNT_NUMBER", "identification": "70000002" } ], "accountBalances": [ { "type": "EXPECTED", "dateTime": "2021-06-09T08:51:02.463Z", "balanceAmount": { "amount": -12.57, "currency": "GBP" }, "creditLineIncluded": false, "creditLines": [] } ] } ] } }, "obie-example-account-response": { "description": "OBIE Example Response", "value": { "meta": { "tracingId": "01191f59dcd54be2854a7e686702dbd6" }, "data": { "id": "700004000000000000000002", "type": "Personal - Current", "balance": -12.57, "currency": "GBP", "usageType": "PERSONAL", "accountType": "CURRENT", "nickname": "xxxx0006", "accountNames": [ { "name": "Mr. Roberto Rastapopoulos & Ivan Sakharine" } ], "accountIdentifications": [ { "type": "SORT_CODE", "identification": "700001" }, { "type": "ACCOUNT_NUMBER", "identification": "70000002" } ], "accountBalances": [ { "type": "EXPECTED", "dateTime": "2021-06-09T08:51:02.463Z", "balanceAmount": { "amount": -12.57, "currency": "GBP" }, "creditLineIncluded": false, "creditLines": [] } ] } } }, "obie-example-acc-beneficiaries-response": { "description": "OBIE Example Response", "value": { "data": [ { "id": "112", "trusted": true, "reference": "Rent", "payee": { "name": "John Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "123456" }, { "type": "ACCOUNT_NUMBER", "identification": "12345678" } ] } } ] } }, "obie-example-acc-direct-debits-response": { "description": "OBIE Example Response", "value": { "meta": { "tracingId": "c2dec674a3fb402e8543129565491244", "count": 2, "pagination": { "totalCount": 2, "self": { "limit": 1000 } } }, "data": [ { "id": "700009000000000000000076", "statusDetails": { "status": "INACTIVE" }, "payeeDetails": { "name": "EDF ENERGY" }, "reference": "671018097704", "previousPaymentAmount": { "amount": 145.0, "currency": "GBP" }, "previousPaymentDateTime": "2016-10-05T00:00:00Z" }, { "id": "700009000000000000000038", "statusDetails": { "status": "ACTIVE" }, "payeeDetails": { "name": "SANTANDER MORTGAGE" }, "reference": "40118272", "previousPaymentAmount": { "amount": 1000.00, "currency": "GBP" }, "previousPaymentDateTime": "2017-12-01T00:00:00Z" } ], "links": { "self": "https://api.yapily.com/accounts/700004000000000000000002/direct-debits?limit=1000" } } }, "obie-example-acc-periodic-payments-response": { "description": "OBIE Example Response", "value": { "meta": { "tracingId": "51d039be096f492ca5184d4ea72b4caf", "count": 1, "pagination": { "totalCount": 1, "self": { "limit": 1000 } } }, "data": [ { "id": "95d29cb3-5ef4-4c92-885f-8ba971adc5d1", "statusDetails": { "status": "UNKNOWN" }, "payeeDetails": { "name": "xxxxx129", "accountIdentifications": [ { "type": "IBAN", "identification": "DE16700222000072880129" } ] }, "reference": "544878_60c0809a", "firstPaymentAmount": { "amount": 1259.00, "currency": "GBP" }, "firstPaymentDateTime": "2021-07-10T23:00:00Z", "nextPaymentAmount": { "amount": 1259.00, "currency": "GBP" }, "nextPaymentDateTime": "2021-07-10T23:00:00Z", "finalPaymentAmount": { "amount": 1259.00, "currency": "GBP" }, "finalPaymentDateTime": "2022-04-11T23:00:00Z", "frequency": { "frequencyType": "MONTHLY", "intervalMonth": 1, "executionDay": 11 } } ], "links": { "self": "https://api.yapily.com/accounts/700004000000000000000002/periodic-payments?limit=1000" } } }, "obie-example-acc-scheduled-payments-response": { "description": "OBIE Example Response", "value": { "meta": { "tracingId": "0de4ed83caf542f6bcaa30c62275191c", "count": 1, "pagination": { "totalCount": 1, "self": { "limit": 1000 } } }, "data": [ { "id": "6f62b428-c3a0-42eb-a838-ae41e52916e9", "payeeDetails": { "name": "Mr. Roberto Rastapopoulos & Ivan Sakharine & mits", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "70000002" }, { "type": "SORT_CODE", "identification": "700001" } ] }, "reference": "f62ee3bad94d432d9786ba038131b5d7", "amountDetails": { "amount": 1.00, "currency": "GBP" }, "scheduledPaymentType": "EXECUTION", "scheduledPaymentDateTime": "2021-12-01T00:00:00+01:00" } ], "links": { "self": "https://api.yapily.com/accounts/700004000000000000000002/scheduled-payments?limit=1000" } } }, "account-statements-example-response": { "description": "Example Response", "value": { "meta": { "tracingId": "fd5c215acd034401a8eaa8aeec1eafc7", "count": 1, "pagination": { "totalCount": 1, "self": { "limit": 1000, "sort": "-date", "offset": 0 } } }, "data": [ { "id": "700014000000000000000002", "startDateTime": "2017-08-01T00:00:00Z", "endDateTime": "2017-08-31T23:59:59Z", "creationDateTime": "2017-09-01T00:00:00Z" } ], "links": { "self": "https://api.yapily.com/accounts/700004000000000000000002/statements?from&before&limit=1000&sort=-date&offset=0" } } }, "account-transactions-example-response": { "description": "Example Response", "value": { "meta": { "tracingId": "488ce8243ee74a378be722ffffec8f7f", "count": 1, "pagination": { "totalCount": 1, "self": { "limit": 1000, "sort": "-date", "offset": 0 } } }, "data": [ { "id": "49d6e5c6-0130-46e3-884b-1b185432d9e0", "date": "2021-05-06T17:44:34.589Z", "bookingDateTime": "2021-05-06T17:44:34.589Z", "valueDateTime": "2021-05-06T17:44:34.589Z", "status": "BOOKED", "amount": -100.23, "currency": "GBP", "transactionAmount": { "amount": -100.23, "currency": "GBP" }, "reference": "0", "description": "Debit for Payment Id: sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60", "transactionInformation": [ "Debit for Payment Id: sdp-1-57379a43-c4b8-49f5-bd7c-699189ee7a60" ], "isoBankTransactionCode": { "domainCode": { "code": "PMNT", "name": "Payments" }, "familyCode": { "code": "ICDT", "name": "Issued Credit Transfers" }, "subFamilyCode": { "code": "DMCT", "name": "Domestic Credit Transfer" } }, "proprietaryBankTransactionCode": { "code": "PMT", "issuer": "modelo-sandbox" }, "balance": { "type": "CLOSING_AVAILABLE", "balanceAmount": { "amount": 426.53, "currency": "GBP" } }, "enrichment": { "transactionHash": { "hash": "adad72d7b3069ab9e4a6cb2844e2e3e9.1" } } } ], "links": { "self": "https://api.yapily.com/accounts/700004000000000000000002/transactions?from&before&limit=1000&sort=-date&offset=0&cursor" } } }, "uk-bulk-payment-auth-example-response": { "description": "UK Bulk Payment Example Response", "value": { "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", "authorisationUrl": "https://ob19-auth1-ui.o3bank.co.uk/auth?client_id=e7f6b95b-5f35-419b-b301-8b08bcd946de&response_type=code+id_token&state=80052c03007f41d589f64377eef4d620&nonce=80052c03007f41d589f64377eef4d620&scope=openid+payments&redirect_uri=https%3A%2F%2Fauth.yapily.com%2F&request=eyJraWQiOiJnRTRvU3VaZDl4TVpUNXZDdTNWYy1mdktNak0iLCJhbGciOiJQUzI1NiJ9.eyJhdWQiOiJodHRwczovL29iMTktYXV0aDEtdWkubzNiYW5rLmNvLnVrIiwic2NvcGUiOiJvcGVuaWQgcGF5bWVudHMiLCJpc3MiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJjbGllbnRfaWQiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJyZXNwb25zZV90eXBlIjoiY29kZSBpZF90b2tlbiIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOi8vYXV0aC55YXBpbHkuY29tLyIsInN0YXRlIjoiODAwNTJjMDMwMDdmNDFkNTg5ZjY0Mzc3ZWVmNGQ2MjAiLCJjbGFpbXMiOnsiaWRfdG9rZW4iOnsiYWNyIjp7InZhbHVlIjoidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoic2RwLTYtMjVmZjViZDgtZDAxYy00MjJkLWFhOWUtOGU2ODgwOGJjODk5IiwiZXNzZW50aWFsIjp0cnVlfX0sInVzZXJpbmZvIjp7Im9wZW5iYW5raW5nX2ludGVudF9pZCI6eyJ2YWx1ZSI6InNkcC02LTI1ZmY1YmQ4LWQwMWMtNDIyZC1hYTllLThlNjg4MDhiYzg5OSIsImVzc2VudGlhbCI6dHJ1ZX19fSwibm9uY2UiOiI4MDA1MmMwMzAwN2Y0MWQ1ODlmNjQzNzdlZWY0ZDYyMCIsImp0aSI6ImUxYjZmMWM4LTQ1ZTktNGM0NS05NGE0LWExMTY1Nzk2NjZiNiIsImlhdCI6MTYyMzI0NjUwNSwiZXhwIjoxNjIzMjQ4MzA1fQ.C5YkClHiDOWl1CKnmEY0gM_JizUuELp2-k7sDjsWV5T-mgTWviO-jM7iVfCf4MsU6batLSBmeUFLco1b3S8PTQkAzwM3laHIgbfDAb_6bYkSBTbPriyzKcC8xAwhX3VdvWtb9qqdrn9zXSmIIITBhJdMzk1cgIjyETD7WNPln839eGP1-w8iB8yDOJOkYGRHJ850mQY-lk61GegmKs5kaxtYPIhrG2gygIi3JsN-uQJ6YOl2-5pylTEcJbuwhFiyeePdqHZdabqW2BSA6lDKQbMV_Zow_zhSWoFFv6RZdXCQpt4TBRj1W7tzZQKin-MC-TpzaF1q07RpSy0NtlN85w", "qrCodeUrl": "https://images.yapily.com/image/2bbb79b8-2c4a-4c8e-9132-0636879437da/1623246505?size=0" } } }, "uk-bulk-payment-example-response": { "description": "UK Bulk Payment Example Response", "value": { "meta": { "tracingId": "0cda48c70f3941148bbee775a65fa3d0" }, "data": { "id": "pv3-a1e2ecb0-270c-42e2-8ba5-005261b629d2", "institutionConsentId": "sdp-6-b06f9a82-c641-4aba-b76d-43e6bc052f75", "institutionInteractionId": "2bb95cee-4118-7844-ae5b-b48c8c9a1b87", "paymentIdempotencyId": "d06e26d3-8cd6-bc74-86eb-8f0f4fe355b2", "paymentScheme": "UK.OBIE.SWIFT", "status": "COMPLETED", "statusDetails": { "status": "COMPLETED", "statusUpdateDate": "2021-06-09T13:53:28.67Z" }, "createdAt": "2021-06-09T13:53:28.67Z", "bulkAmountSum": 7 } } }, "eur-single-domestic-payment-auth-example-response": { "description": "EUR Single Domestic Example Response", "value": { "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", "authorisationUrl": "https://scasandbox.bancobpm.it/sca/login.html?paymentId=79cee256-077f-4e11-a307-43892646a4a6&tppAuthenticationRedirectUri=https%3A%2F%2Fauth.yapily.com%2F%3Ftwofold_redirect%3Dtrue%26state%3D6a5f69be6a084b5c8c1becac88d45c95&tppName=YAPILY+LTD&aspspCode=05034&aspspProductCode=IBP01&tppRegistrationNumber=PSDGB-FCA-927459&hash=GY5CmKG3MVeoxrboUQkjCoIb1X0nGR9ZTfoIG3T%2FLx1At1UJ92w0sjDeRXbNP9NhO203Y03UeI6Xn9ThebOjtQ%3D%3D", "qrCodeUrl": "https://images.yapily.com/image/5955c0db-a5b7-4b12-a682-0f83317ba46d/1623325632?size=0" } } }, "gbp-single-domestic-payment-auth-example-response": { "description": "GBP Single Domestic Example Response", "value": { "meta": { "tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0" }, "data": { "id": "eb39f8ae-aeff-4ffa-a23d-d4a5b3eff406", "userUuid": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d", "applicationUserId": "string", "institutionId": "modelo-sandbox", "status": "AWAITING_AUTHORIZATION", "createdAt": "2021-06-08T09:45:42.145Z", "featureScope": [ "EXISTING_PAYMENTS_DETAILS", "EXISTING_PAYMENT_INITIATION_DETAILS", "CREATE_DOMESTIC_SINGLE_PAYMENT" ], "state": "430b2756e9724c8eaad3862524817260", "institutionConsentId": "sdp-1-6d8d035e-868e-4355-be41-bddc25b7aac8", "authorisationUrl": "https://ob19-auth1-ui.o3bank.co.uk/auth?client_id=e7f6b95b-5f35-419b-b301-8b08bcd946de&response_type=code+id_token&state=430b2756e9724c8eaad3862524817260&nonce=430b2756e9724c8eaad3862524817260&scope=openid+payments&redirect_uri=https%3A%2F%2Fauth.yapily.com%2F&request=eyJraWQiOiJnRTRvU3VaZDl4TVpUNXZDdTNWYy1mdktNak0iLCJhbGciOiJQUzI1NiJ9.eyJhdWQiOiJodHRwczovL29iMTktYXV0aDEtdWkubzNiYW5rLmNvLnVrIiwic2NvcGUiOiJvcGVuaWQgcGF5bWVudHMiLCJpc3MiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJjbGllbnRfaWQiOiJlN2Y2Yjk1Yi01ZjM1LTQxOWItYjMwMS04YjA4YmNkOTQ2ZGUiLCJyZXNwb25zZV90eXBlIjoiY29kZSBpZF90b2tlbiIsInJlZGlyZWN0X3VyaSI6Imh0dHBzOi8vYXV0aC55YXBpbHkuY29tLyIsInN0YXRlIjoiNDMwYjI3NTZlOTcyNGM4ZWFhZDM4NjI1MjQ4MTcyNjAiLCJjbGFpbXMiOnsiaWRfdG9rZW4iOnsiYWNyIjp7InZhbHVlIjoidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoic2RwLTEtNmQ4ZDAzNWUtODY4ZS00MzU1LWJlNDEtYmRkYzI1YjdhYWM4IiwiZXNzZW50aWFsIjp0cnVlfX0sInVzZXJpbmZvIjp7Im9wZW5iYW5raW5nX2ludGVudF9pZCI6eyJ2YWx1ZSI6InNkcC0xLTZkOGQwMzVlLTg2OGUtNDM1NS1iZTQxLWJkZGMyNWI3YWFjOCIsImVzc2VudGlhbCI6dHJ1ZX19fSwibm9uY2UiOiI0MzBiMjc1NmU5NzI0YzhlYWFkMzg2MjUyNDgxNzI2MCIsImp0aSI6IjJjYzczMzRhLTJmMDYtNDNjNi04MDkzLTNiYWZjNjQzMWE0YyIsImlhdCI6MTYyMzE0NTU0MiwiZXhwIjoxNjIzMTQ3MzQyfQ.bh0sCVmwkwbx_rxxIwE6p7SjswaH007bdMJfWYo_njIHwoPOkcGjygi2yU7bpNd7bqeqxY1adtkMg_acg6A7awq1jX7nxv6mZC44Q2zGKNMc_nOQPSNO6LkktRcozBxyJ2sEfLheVmmVsyyCQw4FV0w_7Cgc4tFO11FjZ0LNxbp5kpMCK7SABa4RgvZ4IpG-Zl6jFKHfNK1zUP79yBaQcBvNseIirAmG3iJjdpwVc3tD8bl-0SPcPwStk1A3T8OvOgW8DKM4OSEPgKL73I9CExQiJzYykKYLr8tp9bQmI0OgajVM9BT2nbKszRnRe92gPq31goRHHWhfzgQHKFBCNg", "qrCodeUrl": "https://images.yapily.com/image/5121fd6a-5010-4f36-9c25-df691cf465c1/1623145542?size=0" } } }, "eur-domestic-single-payment-example-response": { "description": "EUR Domestic Single Payment Example Response", "value": { "meta": { "tracingId": "0f14e900011b445fa6b6c2c4272d7321" }, "data": { "id": "a9582f8e-08be-4cca-9f01-1ad3be96532d", "status": "COMPLETED", "statusDetails": { "status": "COMPLETED", "isoStatus": { "code": "ACCP", "name": "AcceptedCustomerProfile" } }, "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "IBAN", "identification": "DE12345678901234567890" } ] }, "payeeDetails": { "name": "Jane Doe", "accountIdentifications": [ { "type": "IBAN", "identification": "BE12345678901234" } ] }, "reference": "Bill Payment", "amount": 1.00, "currency": "EUR", "amountDetails": { "amount": 1.00, "currency": "EUR" } } } }, "gbp-domestic-single-payment-example-response": { "description": "GBP Domestic Single Payment Example Response", "value": { "meta": { "tracingId": "2b93dc6029634a5095b3415cc5cc0e84" }, "data": { "id": "pv3-a6ac6528-e8c8-44eb-b6f9-8521963518dc", "institutionConsentId": "sdp-1-27a192bb-482f-4731-989b-e7271661248c", "paymentIdempotencyId": "4289457hd38djoa783jw9qag3", "paymentLifecycleId": "3gaq9wj387aojd83dh7549824", "status": "COMPLETED", "statusDetails": { "status": "COMPLETED", "statusUpdateDate": "2021-06-10T11:26:54.887Z", "isoStatus": { "code": "ACSC", "name": "AcceptedSettlementCompleted" } }, "payeeDetails": { "name": "Jane Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "12345678" }, { "type": "SORT_CODE", "identification": "123456" } ] }, "reference": "Bill Payment", "amount": 1.00, "currency": "GBP", "amountDetails": { "amount": 1.00, "currency": "GBP" }, "createdAt": "2021-06-10T11:26:54.887Z" } } }, "eur-single-domestic-payment-details-example-response": { "description": "EUR Single Domestic Payment Example Response", "value": { "meta": { "tracingId": "590c99aecd2844c7a5c3ea00c55ce0ef" }, "data": { "payments": [ { "id": "pv3-a6ac6528-e8c8-44eb-b6f9-8521963518dd", "institutionConsentId": "sdp-1-27a192bb-482f-4731-989b-e7271661248d", "paymentIdempotencyId": "234g87t58tgeuo848wudjew489", "paymentLifecycleId": "3gaq9wj387aojd83dh7549824", "status": "COMPLETED", "statusDetails": { "status": "COMPLETED", "statusUpdateDate": "2021-06-10T11:26:54.887Z", "isoStatus": { "code": "ACSC", "name": "AcceptedSettlementCompleted" } }, "payeeDetails": { "name": "Jane Doe", "address": { "country": "BE" }, "accountIdentifications": [ { "type": "IBAN", "identification": "BE12345678901234" } ] }, "reference": "Bill Payment", "amount": 1.00, "currency": "EUR", "amountDetails": { "amount": 1.00, "currency": "EUR" }, "scheduledPaymentType": "DOMESTIC_PAYMENT", "createdAt": "2021-06-10T11:26:54.887Z" } ] } } }, "gbp-single-domestic-payment-details-example-response": { "description": "GBP Single Domestic Payment Example Response", "value": { "meta": { "tracingId": "547ffd74b2ea46968cef64e0ddac59e1" }, "data": { "payments": [ { "id": "pv3-a6ac6528-e8c8-44eb-b6f9-8521963518dc", "institutionConsentId": "sdp-1-27a192bb-482f-4731-989b-e7271661248c", "paymentIdempotencyId": "4289457hd38djoa783jw9qag3", "paymentLifecycleId": "3gaq9wj387aojd83dh7549824", "status": "COMPLETED", "statusDetails": { "status": "COMPLETED", "statusUpdateDate": "2021-06-10T11:26:54.887Z", "isoStatus": { "code": "ACSC", "name": "AcceptedSettlementCompleted" } }, "payeeDetails": { "name": "Jane Doe", "accountIdentifications": [ { "type": "ACCOUNT_NUMBER", "identification": "12345678" }, { "type": "SORT_CODE", "identification": "123456" } ] }, "reference": "Bill Payment", "amount": 1.00, "currency": "GBP", "amountDetails": { "amount": 1.00, "currency": "GBP" }, "createdAt": "2021-06-10T11:26:54.887Z" } ] } } }, "uk-bulk-payment-details-example-response": { "description": "UK Bulk Payment Example Response", "value": { "meta": { "tracingId": "a63d57d771d64875a8230a1fcabd87f2" }, "data": { "payments": [ { "id": "pv3-a1e2ecb0-270c-42e2-8ba5-005261b629d2", "institutionConsentId": "sdp-6-b06f9a82-c641-4aba-b76d-43e6bc052f75", "status": "COMPLETED", "statusDetails": { "status": "COMPLETED", "statusUpdateDate": "2021-06-09T13:53:28.67Z" }, "createdAt": "2021-06-09T13:53:28.67Z", "bulkAmountSum": 7 } ] } } }, "consent-auth-code-example-response": { "description": "Example Response", "value": { "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" } }, "consent-one-time-token-example-response": { "description": "Example Response", "value": { "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" } }, "consents-example-response": { "description": "Example Response", "value": { "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" } ] } }, "consent-delete-example-response": { "description": "Example Response", "value": { "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" } } }, "consent-get-example-response": { "description": "Example Response", "value": { "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" } } }, "consent-extend-example-request": { "description": "Extend Consent Example Request", "value": { "lastConfirmedAt": "2021-07-08T10:59:53.288Z" } }, "identity-example-response": { "description": "Example Response", "value": { "meta": { "tracingId": "e4de605bd760459aa7f82aa81856ec1e" }, "data": { "id": "700001000000000000000002", "fullName": "Mitsuhirato", "email": "mits@suntori.com", "phone": "+22-8937484901", "addresses": [ { "addressLines": [], "city": "Hichikanzo", "postalCode": "JP102", "country": "TA" }, { "addressLines": [], "city": "St Albans", "postalCode": "AL1 3SF", "country": "GB" } ] } } }, "institutions-example-response": { "description": "Example Response", "value": { "meta": { "tracingId": "1304b771e4e34f67b39977bde6b1a8e2", "count": 1 }, "data": [ { "id": "modelo-sandbox", "name": "Modelo Sandbox", "fullName": "Modelo Sandbox", "countries": [ { "displayName": "Italy", "countryCode2": "IT", "bic": "MODEIT21XXX" }, { "displayName": "United Kingdom", "countryCode2": "GB", "bic": "MODEGB21XXX" } ], "environmentType": "SANDBOX", "credentialsType": "OPEN_BANKING_UK_AUTO", "media": [ { "source": "https://images.yapily.com/image/ce2bfdbf-1ae2-4919-ab7b-e8b3d5e93b36?size=0", "type": "icon" }, { "source": "https://images.yapily.com/image/ca502f24-d6df-4785-b4b8-1034b100af77?size=0", "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" ] } ] } }, "institution-example-response": { "description": "Example Response", "value": { "id": "modelo-sandbox", "name": "Modelo Sandbox", "fullName": "Modelo Sandbox", "countries": [ { "displayName": "Italy", "countryCode2": "IT", "bic": "MODEIT21XXX" }, { "displayName": "United Kingdom", "countryCode2": "GB", "bic": "MODEGB21XXX" } ], "environmentType": "SANDBOX", "credentialsType": "OPEN_BANKING_UK_AUTO", "media": [ { "source": "https://images.yapily.com/image/ce2bfdbf-1ae2-4919-ab7b-e8b3d5e93b36?size=0", "type": "icon" }, { "source": "https://images.yapily.com/image/ca502f24-d6df-4785-b4b8-1034b100af77?size=0", "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" ] } }, "create-user-example-request": { "description": "Create User Example Request", "value": { "applicationUserId": "string" } }, "users_example-response": { "description": "Example Response", "value": [ { "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-user_example-response": { "description": "Example Response", "value": { "uuid": "1ec8e814-085e-46ad-a303-3fe11808f67e", "applicationUuid": "50935110-c7df-4003-a06a-1cc5fd4643c9", "applicationUserId": "string", "createdAt": "2022-10-17T08:51:02.463Z", "institutionConsents": [] } }, "delete-user_example-response": { "description": "Example Response", "value": { "meta": { "tracingId": "e6625041a9fb46e2a450b3f9f1528cb8" }, "data": { "id": "b8ebe390-f6fb-45b5-bf20-1b4436644390", "deleteStatus": "SUCCESS", "creationDate": "2021-06-07T16:44:52.221Z", "userConsents": [ { "institutionId": "modelo-sandbox" } ] } } }, "user_example-response": { "description": "Example Response", "value": { "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" } ] } }, "error-response-code-401": { "description": "Error Response", "value": { "error": { "code": 401, "status": "UNAUTHORIZED", "message": "Full authentication is required to access this resource" } } }, "extend-consent-error-response-code-400": { "description": "Error Response", "value": { "error": { "code": 400, "status": "BAD_REQUEST", "message": "lastConfirmedAt cannot be a future date and time" } } }, "create-hosted-consent-request": { "description": "Create Hosted Consent Request", "value": { "userId": "ca412fdf-5a30-43a2-88b7-5964a24a8e55", "applicationUserId": "string", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com/", "authorisationExpiresAt": "2021-06-10T11:36:54.887Z", "oneTimeToken": false, "accountRequest": { "transactionFrom": "2023-07-01T00:00:00.000Z", "transactionTo": "2023-08-01T00:00:00.000Z", "expiresAt": "2023-11-01T00:00:00.000Z", "featureScope": [ "ACCOUNTS", "ACCOUNT", "ACCOUNT_BALANCES", "ACCOUNT_TRANSACTIONS", "IDENTITY" ] } } }, "create-hosted-consent-response": { "description": "Create Hosted Consent Response", "value": { "meta": { "tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0" }, "data": { "consentRequestId": "507e515f-c22d-4bab-9801-606c94e7f749", "userId": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d", "applicationUserId": "string", "applicationId": "64949de6-6510-4d70-9500-d4aa094c506c", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com/", "accountRequestDetails": { "featureScope": [ "ACCOUNTS", "ACCOUNT", "ACCOUNT_BALANCES", "ACCOUNT_TRANSACTIONS", "IDENTITY" ] }, "hostedUrl": "https://prototypes.yapily.com/auth-link1.html", "createdAt": "2024-09-13T11:14:04.766Z", "authorisationExpiresAt": "2024-09-13T11:24:04.000Z" } } }, "create-hosted-payment-request": { "description": "Create Hosted payment request", "value": { "userId": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d", "applicationUserId": "string", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com/", "paymentRequestDetails": { "paymentIdempotencyId": "4289457hd38djoa783jw9qag3", "amountDetails": { "amountToPay": 10.00, "currency": "GBP" }, "reference": "Test Payment", "contextType": "OTHER", "type": "DOMESTIC_PAYMENT", "payee": { "name": "Jane Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "123456" }, { "type": "ACCOUNT_NUMBER", "identification": "12345678" } ] }, "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "121212" }, { "type": "ACCOUNT_NUMBER", "identification": "87654321" } ] } } } }, "create-hosted-payment-request-response": { "description": "Create Hosted Payment Response", "value": { "meta": { "tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0" }, "data": { "paymentRequestId": "eb39f8ae-aeff-4ffa-a23d-d4a5b3eff406", "userId": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d", "applicationUserId": "string", "applicationId": "64949de6-6510-4d70-9500-d4aa094c506c", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com/", "paymentRequestDetails": { "paymentIdempotencyId": "4289457hd38djoa783jw9qag3", "amountDetails": { "amountToPay": 1.00, "currency": "GBP" }, "reference": "Test Payment", "contextType": "OTHER", "type": "DOMESTIC_PAYMENT", "payee": { "name": "Jane Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "123456" }, { "type": "ACCOUNT_NUMBER", "identification": "12345678" } ] }, "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "121212" }, { "type": "ACCOUNT_NUMBER", "identification": "87654321" } ] } }, "hostedUrl": "https://prototypes.yapily.com/auth-link1.html", "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "createdAt": "2021-06-10T11:26:54.887Z", "authorisationExpiresAt": "2021-06-10T11:36:54.887Z", "status": "ACTIVE" } } }, "create-hosted-payment-request-link": { "description": "Create Hosted payment request", "value": { "userId": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d", "applicationUserId": "string", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com/", "paymentRequestDetails": { "amountDetails": { "amountToPay": 1.00, "currency": "GBP" }, "reference": "Test Payment", "contextType": "OTHER", "type": "DOMESTIC_PAYMENT", "payee": { "name": "Jane Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "123456" }, { "type": "ACCOUNT_NUMBER", "identification": "12345678" } ] }, "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "121212" }, { "type": "ACCOUNT_NUMBER", "identification": "87654321" } ] } } } }, "create-hosted-payment-request-link-response": { "description": "Create Hosted Payment Response", "value": { "meta": { "tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0" }, "data": { "paymentRequestId": "eb39f8ae-aeff-4ffa-a23d-d4a5b3eff406", "userId": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d", "applicationUserId": "string", "applicationId": "64949de6-6510-4d70-9500-d4aa094c506c", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com/", "paymentRequestDetails": { "amountDetails": { "amountToPay": 10.00, "currency": "GBP" }, "reference": "Test Payment", "contextType": "OTHER", "type": "DOMESTIC_PAYMENT", "payee": { "name": "Jane Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "123456" }, { "type": "ACCOUNT_NUMBER", "identification": "12345678" } ] }, "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "121212" }, { "type": "ACCOUNT_NUMBER", "identification": "87654321" } ] } }, "hostedUrl": "https://prototypes.yapily.com/auth-link1.html", "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "createdAt": "2021-06-10T11:26:54.887Z", "authorisationExpiresAt": "2021-06-10T11:36:54.887Z", "status": "ACTIVE" } } }, "get-hosted-consent-response": { "description": "Get Hosted Consent Request Response", "value": { "meta": { "tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0" }, "data": { "consentRequestId": "507e515f-c22d-4bab-9801-606c94e7f749", "consentId": "b22a1fe6-1e91-45b3-8ba0-6fdb1708e7bd", "userId": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d", "applicationUserId": "string", "applicationId": "64949de6-6510-4d70-9500-d4aa094c506c", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com/", "createdAt": "2024-09-13T11:14:04.766Z", "authorisationExpiresAt": "2024-10-10T11:36:54.887Z", "status": "AUTHORIZED", "phases": [ { "phaseName": "INITIATED", "phaseCreatedAt": "2024-09-11T16:19:59.707Z" }, { "phaseName": "INSTITUTION_SUBMITTED", "phaseCreatedAt": "2024-09-11T16:20:19.097Z" }, { "phaseName": "AUTHORISATION_INITIATED", "phaseCreatedAt": "2024-09-11T16:20:47.077Z" }, { "phaseName": "AUTHORISATION_CREATED", "phaseCreatedAt": "2024-09-11T16:20:48.212Z" }, { "phaseName": "CONSENT_POLLING_STARTED", "phaseCreatedAt": "2024-09-11T16:20:57.654Z" }, { "phaseName": "CONSENT_POLLING_ENDED", "phaseCreatedAt": "2024-09-11T16:20:58.288Z" }, { "phaseName": "AUTHORISED", "phaseCreatedAt": "2024-09-11T16:20:58.288Z" }, { "phaseName": "FINISHED", "phaseCreatedAt": "2024-09-11T16:20:58.288Z" } ], "consentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg" } } }, "get-hosted-payment-request-response": { "description": "Get Hosted payment request Response", "value": { "meta": { "tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0" }, "data": { "paymentRequestId": "eb39f8ae-aeff-4ffa-a23d-d4a5b3eff406", "userId": "3ddf5dd0-aa48-4d0f-baa7-fa057e9e911d", "applicationUserId": "string", "applicationId": "64949de6-6510-4d70-9500-d4aa094c506c", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com/", "paymentRequestDetails": { "amountDetails": { "amountToPay": 1.00, "currency": "GBP" }, "reference": "Test Payment", "contextType": "OTHER", "type": "DOMESTIC_PAYMENT", "payee": { "name": "Jane Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "123456" }, { "type": "ACCOUNT_NUMBER", "identification": "12345678" } ] }, "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "121212" }, { "type": "ACCOUNT_NUMBER", "identification": "87654321" } ] } }, "createdAt": "2021-06-10T11:26:54.887Z", "authorisationExpiresAt": "2021-06-10T11:36:54.887Z", "status": "ACTIVE", "payments": [ { "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "institutionIdentifiers": { "institutionId": "string", "institutionCountryCode": "GB" }, "userIdentifiers": { "psuId": "string", "psuCorporateId": "string", "psuIpAddress": "string" }, "phases": [ { "phaseName": "INITIATED", "phaseCreatedAt": "2021-06-10T11:26:54.887Z" }, { "phaseName": "INSTITUTION_SUBMITTED", "phaseCreatedAt": "2021-06-10T11:26:55.123Z" }, { "phaseName": "INPUT_CAPTURED", "phaseCreatedAt": "2021-06-10T11:27:05.123Z" }, { "phaseName": "VALIDATION_COMPLETED", "phaseCreatedAt": "2021-06-10T11:27:05.223Z" }, { "phaseName": "AUTHORISATION_CREATED", "phaseCreatedAt": "2021-06-10T11:27:06.637Z" }, { "phaseName": "AUTHORISED", "phaseCreatedAt": "2021-06-10T11:27:10.637Z" }, { "phaseName": "SUBMITTED", "phaseCreatedAt": "2021-06-10T11:27:10.654Z" }, { "phaseName": "ACCEPTED", "phaseCreatedAt": "2021-06-10T11:27:11.867Z" }, { "phaseName": "SETTLEMENT_COMPLETED", "phaseCreatedAt": "2021-06-10T11:27:13.887Z" } ], "paymentStatus": "COMPLETED", "statusDetails": [ { "status": "PENDING", "statusUpdateDate": "2021-06-10T11:27:11.867Z", "isoStatus": { "code": "PDNG", "name": "Pending" } }, { "status": "COMPLETED", "statusUpdateDate": "2021-06-10T11:27:13.887Z", "isoStatus": { "code": "ACSC", "name": "AcceptedSettlementCompleted" } } ], "institutionPaymentId": "string", "paymentLifecycleId": "string", "paymentIdempotencyId": "04ab4536gaerfc0e1f93c4f4", "reference": "Bill payment", "contextType": "OTHER", "type": "DOMESTIC_PAYMENT", "payee": { "name": "Jane Doe", "accountIdentifications": [ { "identification": "401016", "type": "SORT_CODE" }, { "identification": "71518920", "type": "ACCOUNT_NUMBER" } ], "address": { "country": "GB" }, "merchantId": "24589303", "merchantCategoryCode": "5551" }, "payer": { "name": "John Doe", "accountIdentifications": [ { "type": "SORT_CODE", "identification": "401016" } ], "address": { "country": "GB" } }, "amount": { "amount": 10, "currency": "GBP" } } ] } } }, "create-hosted-vrp-consent-request": { "description": "Create Hosted VRP Consent Request", "value": { "applicationUserId": "45cf7ffe-6350-11ee-8c99-0242ac120002", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com", "vrpSetup": { "payee": { "name": "Merchant Doe", "accountIdentifications": [ { "identification": "401016", "type": "SORT_CODE" }, { "identification": "71518920", "type": "ACCOUNT_NUMBER" } ] }, "reference": "Test Payment", "limits": { "periodicLimits": [ { "maxAmount": { "amount": 100, "currency": "GBP" }, "frequency": "MONTHLY", "alignment": "CALENDAR" } ], "maxAmountPerPayment": { "amount": 10, "currency": "GBP" } }, "validFrom": "2023-10-04T16:41:17.870Z", "validTo": "2024-10-04T16:41:17.870Z", "recurringPaymentCategory": "ONGOING", "risk": { "contextType": "ECOMMERCE_MERCHANT" } } } }, "create-hosted-vrp-consent-response": { "description": "Create Hosted VRP Consent Response", "value": { "meta": { "tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0" }, "data": { "id": "ad4bfe58-6352-11ee-8c99-0242ac120002", "applicationUserId": "45cf7ffe-6350-11ee-8c99-0242ac120002", "applicationId": "ea4cdf01ee-278f-4e3e-8b30-695515aa4cdf01d64", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com", "vrpSetup": { "payee": { "name": "Merchant Doe", "accountIdentifications": [ { "identification": "401016", "type": "SORT_CODE" }, { "identification": "71518920", "type": "ACCOUNT_NUMBER" } ] }, "reference": "Test Payment", "limits": { "periodicLimits": [ { "maxAmount": { "amount": 100, "currency": "GBP" }, "frequency": "MONTHLY", "alignment": "CALENDAR" } ], "maxAmountPerPayment": { "amount": 10, "currency": "GBP" } }, "validFrom": "2023-10-04T16:41:17.870Z", "validTo": "2024-10-04T16:41:17.870Z", "risk": { "contextType": "ECOMMERCE_MERCHANT" } }, "hostedUrl": "https://payments.yapily.com/vrp?authToken=eyJra&applicationId=e5515aee-278f-4e3e-8b30-69a4cdf01d64", "authToken": "eyJraWQiOiIwNmViZTQ1Yy1OiJFUzI1NiJ9.eyJhdWQiOiJwcm9kdWN0aW9uIiwic3ViIjoiZTU1MTVhZWUtMjc4Zi00ZTNlLThiMzAtNjlhNGNkZjAxZDY0Iiwib3JnIjoiYTUwZmEwNWUtNWIwYy00MGIxLTk0NWUtOTcxM2JkOGQzODk4IiwiY29uc2VudFJlcXVlc3RJZCI6IjdkMmMzZjU5LTU3NDgtNDhlNS1hODdjLWVkZmRkODJiMzQxZCIsImlzcyI6Imhvc3RlZC12cjgwMDE2NCwiaWF0IjoxNzA2Nzk5NTY0LCJqdGkiOiJjMTFkNTBkNy0wMjkxLTRhNTktYmFhNy1jZDhhYWIzMmYzOWIifQ.xa38HzD6phhFiR069E9nMrzvQ9GCmNZMQ", "createdAt": "2024-02-01T14:59:25.007193Z" } } }, "get-hosted-vrp-consent-response": { "description": "Get Hosted VRP Consent Response", "value": { "meta": { "tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0" }, "data": { "id": "ad4bfe58-6352-11ee-8c99-0242ac120002", "applicationUserId": "45cf7ffe-6350-11ee-8c99-0242ac120002", "applicationId": "ea4cdf01ee-278f-4e3e-8b30-695515aa4cdf01d64", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com", "vrpSetup": { "payer": { "accountIdentifications": [ { "type": "MASKED_ACCOUNT_NUMBER", "identification": "*****493" } ] }, "payee": { "name": "Merchant Doe", "accountIdentifications": [ { "identification": "401016", "type": "SORT_CODE" }, { "identification": "71518920", "type": "ACCOUNT_NUMBER" } ] }, "reference": "Test Payment", "limits": { "periodicLimits": [ { "maxAmount": { "amount": 100, "currency": "GBP" }, "frequency": "MONTHLY", "alignment": "CALENDAR" } ], "maxAmountPerPayment": { "amount": 10, "currency": "GBP" } }, "validFrom": "2023-10-04T16:41:17.870Z", "validTo": "2024-10-04T16:41:17.870Z", "recurringPaymentCategory": "ONGOING", "risk": { "contextType": "ECOMMERCE_MERCHANT" } }, "createdAt": "2023-10-05T07:56:44.552Z", "authorisationExpiresAt": "2023-10-05T07:56:44.552Z", "consentStatus": "AUTHORIZED", "consentToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJJTlNUSVRVVElPTiI6Im1vZGVsby1zYW5kYm94IiwiQ09OU0VOVCI6IjU2YTQyMjQ0LTQxNGEtNGI1Mi04YzRmLTRhZDJhNTBlODJmZSIsIkFQUExJQ0FUSU9OX1VTRVJfSUQiOiJtb2ZlLTIiLCJVU0VSIjoiY2E0MTJmZGYtNWEzMC00M2EyLTg4YjctNTk2NGEyNGE4ZTU1In0.gorwpnUjSr5dzQJLR32M2geWOj7yK9xMsZmq27ssY9xP_xGmWfUL_aqVHYyQ4r5KWw6Xb6RjvO839st8chJLtg", "phases": [ { "phaseName": "INITIATED", "phaseCreatedAt": "2023-05-10T07:56:54.887Z" }, { "phaseName": "INPUT_CAPTURED", "phaseCreatedAt": "2023-05-10T07:57:05.123Z" }, { "phaseName": "VALIDATION_COMPLETED", "phaseCreatedAt": "2023-05-10T07:57:05.223Z" }, { "phaseName": "AUTHORISATION_CREATED", "phaseCreatedAt": "2023-05-10T07:57:06.637Z" }, { "phaseName": "AUTHORISED", "phaseCreatedAt": "2023-05-10T07:57:10.637Z" }, { "phaseName": "SUBMITTED", "phaseCreatedAt": "2023-05-10T07:57:10.654Z" }, { "phaseName": "ACCEPTED", "phaseCreatedAt": "2023-05-10T07:57:11.867Z" } ] } } }, "get-hosted-vrp-consents-response": { "description": "Get Hosted VRP Consents Response", "value": { "meta": { "tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0" }, "data": [ { "id": "ad4bfe58-6352-11ee-8c99-0242ac120002", "applicationId": "45cf7ffe-6350-11ee-8c99-0242ac120002", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "vrpSetup": { "limits": { "periodicLimits": [ { "maxAmount": { "amount": 100, "currency": "GBP" }, "frequency": "MONTHLY", "alignment": "CALENDAR" } ], "maxAmountPerPayment": { "amount": 10, "currency": "GBP" } }, "recurringPaymentCategory": "ONGOING", "risk": { "contextType": "ECOMMERCE_MERCHANT" } }, "updatedAt": "2023-10-05T07:56:44.552Z", "consentStatus": "AUTHORIZED" } ] } }, "revoke-hosted-vrp-consent-response": { "description": "Revoke Hosted VRP Consent Response", "value": { "meta": { "tracingId": "2dbfd85b4f2940c6a206e96dd90e52d0" }, "data": { "id": "ad4bfe58-6352-11ee-8c99-0242ac120002", "applicationUserId": "45cf7ffe-6350-11ee-8c99-0242ac120002", "applicationId": "ea4cdf01ee-278f-4e3e-8b30-695515aa4cdf01d64", "institutionIdentifiers": { "institutionId": "modelo-sandbox", "institutionCountryCode": "GB" }, "userSettings": { "language": "en", "location": "GB" }, "redirectUrl": "https://tpp-application.com", "vrpSetup": { "payee": { "name": "Merchant Doe", "accountIdentifications": [ { "identification": "401016", "type": "SORT_CODE" }, { "identification": "71518920", "type": "ACCOUNT_NUMBER" } ] }, "reference": "Test Payment", "limits": { "periodicLimits": [ { "maxAmount": { "amount": 100, "currency": "GBP" }, "frequency": "MONTHLY", "alignment": "CALENDAR" } ], "maxAmountPerPayment": { "amount": 10, "currency": "GBP" } }, "validFrom": "2023-10-04T16:41:17.870Z", "validTo": "2024-10-04T16:41:17.870Z", "risk": { "contextType": "ECOMMERCE_MERCHANT" } }, "createdAt": "2023-10-05T07:56:44.552Z", "authorisationExpiresAt": "2023-10-05T07:56:44.552Z", "consentStatus": "REVOKED", "phases": [ { "phaseName": "INITIATED", "phaseCreatedAt": "2023-05-10T07:56:54.887Z" }, { "phaseName": "INPUT_CAPTURED", "phaseCreatedAt": "2023-05-10T07:57:05.123Z" }, { "phaseName": "VALIDATION_COMPLETED", "phaseCreatedAt": "2023-05-10T07:57:05.223Z" }, { "phaseName": "AUTHORISATION_CREATED", "phaseCreatedAt": "2023-05-10T07:57:06.637Z" }, { "phaseName": "AUTHORISED", "phaseCreatedAt": "2023-05-10T07:57:10.637Z" }, { "phaseName": "SUBMITTED", "phaseCreatedAt": "2023-05-10T07:57:10.654Z" }, { "phaseName": "ACCEPTED", "phaseCreatedAt": "2023-05-10T07:57:11.867Z" }, { "phaseName": "REVOKED", "phaseCreatedAt": "2023-05-11T09:57:11.867Z" } ] } } }, "create-hosted-vrp-payment-request": { "description": "Create Hosted VRP Payment Request", "value": { "paymentIdempotencyId": "234g87t58tgeuo848wudjew489", "amount": { "amount": 10, "currency": "GBP" } } }, "create-hosted-vrp-fund-confirmation": { "description": "Create Hosted VRP Fund Confirmation Request", "value": { "reference": "Own Account Sweeping", "paymentAmount": { "amount": 10, "currency": "GBP" } } }, "create-hosted-vrp-fund-confirmation-response": { "description": "Created Hosted VRP Fund Confirmation Response", "value": { "meta": { "tracingId": "0f14e900011b445fa6b6c2c4272d7321" }, "data": { "id": "a9582f8e-08be-4cca-9f01-1ad3be96532d", "fundsAvailable": { "fundsAvailable": true, "fundsAvailableAt": "2021-06-08T10:59:35.138Z" }, "reference": "Own Account Sweeping", "paymentAmount": { "amount": 10, "currency": "GBP" } } } }, "create-hosted-vrp-payment-response": { "description": "Created Hosted VRP Payment Response", "value": { "meta": { "tracingId": "d80a638a-635e-11ee-8c99-0242ac120002" }, "data": { "id": "string", "paymentIdempotencyId": "234g87t58tgeuo848wudjew489", "amount": { "amount": 10, "currency": "GBP" }, "reference": "Test Payment", "payee": { "name": "Merchant Doe", "accountIdentifications": [ { "identification": "401016", "type": "SORT_CODE" }, { "identification": "71518920", "type": "ACCOUNT_NUMBER" } ] }, "refundAccount": { "name": "string", "accountIdentifications": [ { "type": "MASKED_ACCOUNT_NUMBER", "identification": "*****493" } ] }, "paymentLifecycleId": "234g87t58tgeuo848wudjew489", "institutionPaymentId": "35a4bd02-635e-11ee-8c99-0242ac120002", "statusDetails": { "status": "PENDING", "statusUpdateDate": "2023-10-05T09:00:36.360Z", "isoStatus": { "code": "PDNG", "name": "Pending" } } } } }, "get-hosted-vrp-payment-response": { "description": "Get Hosted VRP Payment Response", "value": { "meta": { "tracingId": "d80a638a-635e-11ee-8c99-0242ac120002" }, "data": { "id": "string", "paymentIdempotencyId": "234g87t58tgeuo848wudjew489", "amount": { "amount": 10, "currency": "GBP" }, "reference": "Test Payment", "payee": { "name": "Merchant Doe", "accountIdentifications": [ { "identification": "401016", "type": "SORT_CODE" }, { "identification": "71518920", "type": "ACCOUNT_NUMBER" } ] }, "refundAccount": { "name": "string", "accountIdentifications": [ { "type": "MASKED_ACCOUNT_NUMBER", "identification": "*****493" } ] }, "paymentLifecycleId": "234g87t58tgeuo848wudjew489", "institutionPaymentId": "35a4bd02-635e-11ee-8c99-0242ac120002", "statusDetails": { "status": "COMPLETED", "statusUpdateDate": "2023-10-05T09:00:36.360Z", "isoStatus": { "code": "ACSC", "name": "AcceptedSettlementCompleted" } } } } }, "get-categorised-transactions-response": { "value": { "meta": { "tracingId": "string", "count": 1, "pageCount": 1 }, "data": { "transactions": [ { "enrichment": { "transactionHash": { "hash": "6f465bde795b33e497d36333c9a32877.1" }, "categorisation": { "categories": [ "refund" ] }, "merchant": { "id": "dd0f0493-da4c-1334-50cb-b22ad7327b39", "name": "Uber", "logo": "https://example.org/logo.png" } }, "recurrence": "one-off", "paymentProcessor": "PayPal", "location": "1725 Third Street, San Francisco 94158, United States", "merchant": { "merchantCategoryCode": "4121", "name": "Uber" }, "id": "236d3792-7014-8f74-53a3-2d600d07840e", "date": "2026-01-20T09:13:02.752Z", "bookingDateTime": "2026-01-20T09:13:02.752Z", "description": "...", "transactionAmount": { "amount": 23.87, "currency": "GBP" }, "amount": 23.87, "currency": "GBP", "status": "BOOKED", "reference": "...", "proprietaryBankTransactionCode": { "code": "REFUND", "issuer": "bank_id" }, "isoBankTransactionCode": { "domainCode": { "code": "PMNT", "name": "Payments" }, "familyCode": { "code": "RCDT", "name": "Received Credit Transfers" }, "subFamilyCode": { "code": "DMCT", "name": "Domestic Credit Transfer" } } } ] }, "links": { "first": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=aaa", "prev": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=bbb", "self": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=ccc", "next": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=ddd", "last": "https://api.yapily.com/accounts/700004000000000000000002/transactions?cursor=zzz" } } }, "create-transactions-categorisation-response": { "value": { "meta": { "tracingId": "string" }, "data": { "categorisationId": "ed8ea63f-7a1e-05d4-3633-a8a9175b50da" } } }, "application-request": { "value": { "name": "Merchant Uno", "merchantCategoryCode": 7995, "ppcUserGroup": "WHOLESALE_FI_FI", "callbackUrls": [ "https://www.callback-service.com" ], "isContractPresent": true } }, "application-response": { "value": { "meta": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154" }, "data": { "id": "2698db90-6635-4f76-b673-5ce8e2aeda0e", "name": "Merchant Uno", "merchantCategoryCode": 7995, "ppcUserGroup": "WHOLESALE_FI_FI", "callbackUrls": [ "https://www.callback-service.com" ], "isContractPresent": true, "rootApplicationId": "eb25e1ee-f6af-4131-92fe-748e177bf950" } } }, "application-responses": { "value": { "meta": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "count": 1, "pagination": { "offset": 0, "limit": 1, "totalCount": 1 } }, "data": [ { "id": "2698db90-6635-4f76-b673-5ce8e2aeda0e", "name": "Merchant Uno", "merchantCategoryCode": 7995, "ppcUserGroup": "WHOLESALE_FI_FI", "callbackUrls": [ "https://www.callback-service.com" ], "isContractPresent": true, "rootApplicationId": "eb25e1ee-f6af-4131-92fe-748e177bf950" } ] } }, "application-error-response-code-400": { "value": { "name-is-mandatory": { "value": { "errors": [ { "fieldName": "name", "error": "MANDATORY" } ] } } } }, "400-error-response": { "description": "400 Error", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 400, "status": "BAD_REQUEST", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "BAD_REQUEST", "code": 10600, "message": "The server could not understand the request due to invalid syntax" } ] } } }, "401-error-response": { "description": "401 Error", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 401, "status": "UNAUTHORIZED", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "CREDENTIALS", "code": 10700, "message": "Authorization header invalid or credentials not authenticated" } ] } } }, "403-error-response": { "description": "403 Error", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 403, "status": "FORBIDDEN", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "INVALID_REQUEST", "code": "Yapily.gateway.api.scope.required", "message": "You don't have the right scope to access this resource" } ] } } }, "404-error-response": { "description": "404 Error", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 404, "status": "NOT FOUND", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "INVALID_REQUEST", "code": 10800, "message": "Resource not found" } ] } } }, "406-error-response": { "description": "404 Error", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 406, "status": "NOT_ACCEPTABLE", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "RESOURCE", "code": 14007, "message": "Maximum number of resources that can be created has been reached" } ] } } }, "500-error-response": { "description": "500 Error", "value": { "error": { "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154", "code": 500, "status": "INTERNAL SERVER ERROR", "supportUrl": "https://support.yapily.com/", "source": "YAPILY", "issues": [ { "type": "INTERNAL_SERVER_ERROR", "code": 11000, "message": "Unexpected server error" } ] } } } }, "responses": { "WebhookDetailsWithSecret": { "description": "Webhook Details", "content": { "application/json;charset=UTF-8": { "schema": { "type": "object", "properties": { "metadata": { "$ref": "#/components/schemas/Metadata" }, "data": { "allOf": [ { "$ref": "#/components/schemas/RegisteredWebhookWithStatus" }, { "type": "object", "properties": { "webhookSecret": { "type": "string", "description": "HMAC secret needed to validate that the request payload is genuine" } } } ] } } } } } }, "200": { "description": "ok" }, "400": { "description": "Bad Request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "401": { "description": "Unauthorised. Credentials are missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "403": { "description": "Forbidden. Permission to access this endpoint is not granted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "404": { "description": "Not Found. Resource requested is not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "424": { "description": "A failure occurred during an interaction with a third party provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } }, "500": { "description": "Unexpected Error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorResponse" } } } } } } }