Yapily

https://docs.yapily.com/
Admin
Yapily provides an API for accessing financial data and making payments, enabling developers to...
Tokens:440,666
Snippets:1,157
Trust Score:9.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get Hosted VRP Consents Response Example

Source: https://docs.yapily.com/api-reference/hosted-payment-pages/get-hosted-vrp-consent-requests

Example of a successful response when retrieving hosted VRP consents. It includes details about the consent, limits, and associated metadata.

```json
{
  "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"
    }
  ]
}
```

--------------------------------

### GET /hosted/consent-requests Response Example

Source: https://docs.yapily.com/tools-and-services/hosted-pages/data-consent-statuses

This example shows the 'consentStatus' and 'phases' fields from a GET /hosted/consent-requests/{consentRequestId} API response. The 'phases' array details the chronological progression of the consent request, while 'consentStatus' indicates its current state.

```json
{
  "data": {
    "consentStatus": "AUTHORIZED",
    "phases": [
      {
        "phaseName": "INITIATED",
        "phaseCreatedAt": "2023-05-10T07:56:54.887Z"
      },
      {
        "phaseName": "INSTITUTION_SUBMITTED",
        "phaseCreatedAt": "2023-05-10T07:57:02.123Z"
      },
      {
        "phaseName": "AUTHORISATION_INITIATED",
        "phaseCreatedAt": "2023-05-10T07:57:05.123Z"
      },
      {
        "phaseName": "AUTHORISATION_CREATED",
        "phaseCreatedAt": "2023-05-10T07:57:06.637Z"
      },
      {
        "phaseName": "CONSENT_POLLING_STARTED",
        "phaseCreatedAt": "2023-05-10T07:57:07.654Z"
      },
      {
        "phaseName": "CONSENT_POLLING_ENDED",
        "phaseCreatedAt": "2023-05-10T07:57:10.288Z"
      },
      {
        "phaseName": "AUTHORISED",
        "phaseCreatedAt": "2023-05-10T07:57:10.637Z"
      },
      {
        "phaseName": "FINISHED",
        "phaseCreatedAt": "2023-05-10T07:57:11.867Z"
      }
    ]
  }
}
```

--------------------------------

### Get Hosted VRP Payment Response Example

Source: https://docs.yapily.com/api-reference/hosted-payment-pages/get-vrp-payment

An example of a successful response when retrieving a Hosted VRP payment.

```APIDOC
## Get Hosted VRP Payment Response Example

### Description
Example of a successful response for a Hosted VRP payment retrieval.

### Response Example
```json
{
  "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 Hosted VRP Consent Response Example

Source: https://docs.yapily.com/api-reference/hosted-payment-pages/get-hosted-vrp-consent-request

Example of a successful response when retrieving a Hosted VRP Consent. It includes details about the consent, payer, payee, limits, and status.

```json
{
  "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 Account Direct Debits Example

Source: https://docs.yapily.com/api-reference/financial-data/get-account-direct-debits

Example response for retrieving direct debits associated with a specific bank account.

```json
{
  "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,
        "currency": "GBP"
      },
      "previousPaymentDateTime": "2016-10-05T00:00:00Z"
    },
    {
      "id": "700009000000000000000038",
      "statusDetails": {
        "status": "ACTIVE"
      },
      "payeeDetails": {
        "name": "SANTANDER MORTGAGE"
      },
      "reference": "40118272",
      "previousPaymentAmount": {
        "amount": 1000,
        "currency": "GBP"
      },
      "previousPaymentDateTime": "2017-12-01T00:00:00Z"
    }
  ],
  "links": {
    "self": "https://api.yapily.com/accounts/700004000000000000000002/direct-debits?limit=1000"
  }
}
```

--------------------------------

### User ID Parameter Example

Source: https://docs.yapily.com/api-reference/user-beneficiaries/approve-beneficiary

Example value for the userId path parameter.

```json
e7b7636d-a041-4013-8a1b-34dc85b7d341
```

--------------------------------

### Application Request and Response Examples

Source: https://docs.yapily.com/api-reference/application-management/creates-a-sub-application-for-the-root-application-id-provided-in-the-authentication-token

Examples of the JSON structure for creating an application and the corresponding successful response.

```json
{
  "name": "Merchant Uno",
  "merchantCategoryCode": 7995,
  "ppcUserGroup": "WHOLESALE_FI_FI",
  "callbackUrls": [
    "https://www.callback-service.com"
  ],
  "isContractPresent": true
}
```

```json
{
  "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"
  }
}
```

--------------------------------

### User Beneficiary Name Example

Source: https://docs.yapily.com/api-reference/user-beneficiaries/approve-beneficiary

Example value for the beneficiary name field.

```json
John Doe
```

--------------------------------

### Create Account Authorisation Response Example

Source: https://docs.yapily.com/api-reference/authorisations/create-account-authorisation

Example JSON response returned after successfully creating an account authorisation request.

```json
{
  "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"
    ]
  }
}
```

--------------------------------

### Create Account Authorisation Request Example

Source: https://docs.yapily.com/api-reference/authorisations/create-account-authorisation

Example JSON payload for initiating an account authorisation request.

```json
{
  "applicationUserId": "string",
  "institutionId": "modelo-sandbox",
  "callback": "https://display-parameters.com/"
}
```

--------------------------------

### Hosted VRP Funds Confirmation Examples

Source: https://docs.yapily.com/api-reference/hosted-payment-pages/check-funds-availability

Examples for the funds confirmation request and response payloads.

```json
{
  "reference": "Own Account Sweeping",
  "paymentAmount": {
    "amount": 10,
    "currency": "GBP"
  }
}
```

```json
{
  "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"
    }
  }
}
```

--------------------------------

### Example Certificate Upload Format

Source: https://docs.yapily.com/institution-configurations/france/Arkea-Group

Certificates for registration must be appended in the order: QSEAL/QWAC, Intermediate CA, then Root CA. This example shows the structure of the certificates.

```text
-----BEGIN CERTIFICATE-----
MIIHfDCCBWSgAwIBAgIUYImxnz9CjSlR4qjWEwkWHfeBH6kwDQYJKoZIhvcNAQEL
<..and so on...>
19elYPNdZhl1pCxAy8dduotshRw2ONI16f8DFSRYmwY/mWCh1oFqEsXoT0mxxYaj
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIHszCCBZugAwIBAgIUNgYGCneQH5TiHtlT8u0h6XcfdmEwDQYJKoZIhvcNAQEL
<..and so on...>
BkqPNd/MXEMJGdVMKAeNncbqNeAUt13MUNn1NE0G+TQu4aVkYOJfq42gUfJu5ejz
05T1O2pMrA==
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIF1jCCA76gAwIBAgIUXPhoWe8aK2+a26ov44mnhAwDA6EwDQYJKoZIhvcNAQEL
<..and so on...>
2zEVJK4Az1nljA9vTY2dZFNDOSzVK84cio4jQkB1SuTDwL/0a5urw3fUIJgz7YI9
P92ky9jdw1v9Ow==
-----END CERTIFICATE-----
```

--------------------------------

### Approve Beneficiary Response Example

Source: https://docs.yapily.com/api-reference/user-beneficiaries/approve-beneficiary

Successful response example for the approveBeneficiary operation.

```json
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
```

--------------------------------

### Approve Beneficiary Request Example

Source: https://docs.yapily.com/api-reference/user-beneficiaries/approve-beneficiary

Example payload for the approveBeneficiary operation, providing beneficiary validation details.

```json
name: John Doe
match:
  status: FULL_MATCH
accountIdentifier:
  type: IBAN
  identification: GB33BUKB2020155555555
```

--------------------------------

### Hosted Payment Webhook Success Example

Source: https://docs.yapily.com/tools-and-services/hosted-pages/payment-webhooks

Example payload for a successful hosted payment completion webhook.

```APIDOC
### Success Event Example

```json
{
  "type": "hosted_pis.payment_status.completed.v1",
  "applicationId": "a75620ec-8a74-408d-b13f-84227036cf43",
  "id": "b59e9533-24a0-4fd0-afc8-0c0c1a186f34",
  "event": {
    "consentId": "2427faa9-08e2-404e-90f1-4a312dc5f80d",
    "institutionId": "mock-sandbox",
    "paymentId": "9c5f7701-5275-442f-9d86-80d3ddc5cccc",
    "paymentRequestId": "dedcc4f9-7d6d-451c-accc-8a322f153a56",
    "isoStatus": {
      "code": "ACSC",
      "name": "AcceptedSettlementCompleted"
    },
    "status": "COMPLETED"
  },
  "metadata": {
    "tracingId": "6cf5ef06-9f96-4f24-8bab-32ab09128010",
    "user": {
      "key": "value"
    }
  }
}
```

### Success Event Fields

| Property                 | Type   | Description                                        |
| ------------------------ | ------ | -------------------------------------------------- |
| `id`                     | String | The webhook delivery ID                            |
| `applicationId`          | String | The application that registered the webhook        |
| `type`                   | String | The triggered event type                           |
| `event.consentId`        | String | Consent ID associated with the payment             |
| `event.institutionId`    | String | Institution from which the payment was initiated   |
| `event.paymentId`        | String | Payment ID (typically provided by the institution) |
| `event.paymentRequestId` | String | Payment Request ID created at payment initiation   |
| `event.status`           | String | Final payment status (`COMPLETED`)                 |
| `event.isoStatus.code`   | String | Optional ISO 20022 status code                     |
| `event.isoStatus.name`   | String | Human-readable ISO status name                     |
| `metadata.tracingId`     | String | Tracing ID for observability and debugging         |
| `metadata.user`          | Object | Optional metadata provided at webhook registration |
```

--------------------------------

### 404 Not Found Error Response Example

Source: https://docs.yapily.com/api-reference/hosted-payment-pages/get-hosted-vrp-consent-request

Example of a 404 Not Found error response. This indicates that the requested resource could not be found.

```json
{
  "error": {
    "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
    "code": 404,
    "status": "NOT FOUND",
    "supportUrl": "https://support.yapily.com/",
    "source": "YAPILY",
    "issues": [
      {
        "type": "INVALID_REQUEST"
      }
    ]
  }
}
```

--------------------------------

### Extend Consent Success Response Example

Source: https://docs.yapily.com/api-reference/consents/extend-consent

This example shows a successful response when extending a consent. It includes metadata and the updated consent details.

```json
{
  "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"
  }
}
```

--------------------------------

### Handle Application Response

Source: https://docs.yapily.com/api-reference/application-management/update-an-application

Example response returned after a successful application creation.

```json
{
  "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"
  }
}
```

--------------------------------

### Create Account Authorisation

Source: https://docs.yapily.com/data/validate/tutorial-validate-user

Initiate the authorization flow by providing the institution ID and a callback URL. This example uses a single redirect flow.

```bash
curl -L -X POST 'https://api.yapily.com/account-auth-requests' \
 -H 'Content-Type: application/json' \
 -u 'APPLICATION_KEY:APPLICATION_SECRET' \
 -d '{
   "applicationUserId": "account-data-and-transactions-tutorial",
   "institutionId": "modelo-sandbox",
   "callback": "https://display-parameters.com/"
 }'
```

```json
{
  "meta": {
    "tracingId": "ceab45e96f852afdb59ec8eaf8f93594"
  },
  "data": {
    "id": "979f8a58-c955-46b5-b25d-bdc447c28a80",
    "userUuid": "c78035e1-3140-44f7-9539-527785069356",
    "applicationUserId": "account-data-and-transactions-tutorial",
    "institutionId": "modelo-sandbox",
    "status": "AWAITING_AUTHORIZATION",
    "createdAt": "2021-03-04T11:05:17.234Z",
    "featureScope": [
      "ACCOUNT_STATEMENT_FILE",
      "ACCOUNT_STATEMENTS",
      "ACCOUNT_BALANCES",
      "ACCOUNT_SCHEDULED_PAYMENTS",
      "ACCOUNT_STATEMENT",
      "ACCOUNT_TRANSACTIONS_WITH_MERCHANT",
      "ACCOUNT_TRANSACTIONS",
      "ACCOUNT_DIRECT_DEBITS",
      "IDENTITY",
      "ACCOUNT",
      "ACCOUNTS",
      "ACCOUNT_PERIODIC_PAYMENTS"
    ]
```

--------------------------------

### Get Hosted VRP Consent Response

Source: https://docs.yapily.com/api-reference/hosted-payment-pages/get-hosted-vrp-consent-request

Example response for retrieving a Hosted VRP Consent.

```APIDOC
## GET /websites/yapily/hosted-vrp-consent-response

### Description
Retrieves the details of a Hosted VRP Consent.

### Method
GET

### Endpoint
/websites/yapily/hosted-vrp-consent-response

### Response
#### Success Response (200)
- **meta** (object) - Metadata about the request.
  - **tracingId** (string) - Unique identifier for tracing the request.
- **data** (object) - The VRP consent details.
  - **id** (string) - The unique identifier for the VRP consent.
  - **applicationUserId** (string) - The identifier for the user associated with the application.
  - **applicationId** (string) - The identifier for the application.
  - **institutionIdentifiers** (object) - Identifiers for the financial institution.
    - **institutionId** (string) - The ID of the institution.
    - **institutionCountryCode** (string) - The country code of the institution.
  - **userSettings** (object) - User-specific settings.
    - **language** (string) - The preferred language for the user.
    - **location** (string) - The user's location.
  - **redirectUrl** (string) - The URL to redirect the user after authorization.
  - **vrpSetup** (object) - Configuration for the VRP setup.
    - **payer** (object) - Details of the payer.
      - **accountIdentifications** (array) - List of payer account identifications.
        - **type** (string) - The type of account identification (e.g., MASKED_ACCOUNT_NUMBER).
        - **identification** (string) - The account identification value.
    - **payee** (object) - Details of the payee.
      - **name** (string) - The name of the payee.
      - **accountIdentifications** (array) - List of payee account identifications.
        - **identification** (string) - The account identification value.
        - **type** (string) - The type of account identification (e.g., SORT_CODE).
    - **reference** (string) - A reference for the payment.
    - **limits** (object) - Payment limits.
      - **periodicLimits** (array) - Periodic payment limits.
        - **maxAmount** (object) - The maximum amount for a periodic payment.
          - **amount** (number) - The amount.
          - **currency** (string) - The currency of the amount.
        - **frequency** (string) - The frequency of the limit (e.g., MONTHLY).
        - **alignment** (string) - The alignment of the frequency (e.g., CALENDAR).
      - **maxAmountPerPayment** (object) - The maximum amount per payment.
        - **amount** (number) - The amount.
        - **currency** (string) - The currency of the amount.
    - **validFrom** (string) - The date and time from which the VRP is valid.
    - **validTo** (string) - The date and time until which the VRP is valid.
    - **recurringPaymentCategory** (string) - The category of the recurring payment (e.g., ONGOING).
    - **risk** (object) - Risk-related information.
      - **contextType** (string) - The type of risk context (e.g., ECOMMERCE_MERCHANT).
  - **createdAt** (string) - The date and time when the consent was created.
  - **authorisationExpiresAt** (string) - The date and time when the authorization expires.
  - **consentStatus** (string) - The current status of the consent.
  - **consentToken** (string) - The token representing the consent.
  - **phases** (array) - A list of phases in the consent lifecycle.
    - **phaseName** (string) - The name of the phase.
    - **phaseCreatedAt** (string) - The date and time when the phase was created.

### Request Example
```json
{
  "example": "GET /websites/yapily/hosted-vrp-consent-response"
}
```

### Response Example
```json
{
  "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"
      }
    ]
  }
}
```
```

--------------------------------

### Create Account Authorisation Request

Source: https://docs.yapily.com/data/tutorial-account-and-trans-data

Execute this endpoint to initiate an account authorisation request. Include the institution ID and your callback URL. This example uses a single redirect flow.

```bash
curl -L -X POST 'https://api.yapily.com/account-auth-requests' \
   -H 'Content-Type: application/json' \
   -u 'APPLICATION_KEY:APPLICATION_SECRET' \
   -d '{
     "applicationUserId": "account-data-and-transactions-tutorial",
     "institutionId": "modelo-sandbox",
     "callback": "https://display-parameters.com/"
   }'
```

```json
{
  "meta": {
    "tracingId": "ceab45e96f852afdb59ec8eaf8f93594"
  },
  "data": {
    "id": "979f8a58-c955-46b5-b25d-bdc447c28a80",
    "userUuid": "c78035e1-3140-44f7-9539-527785069356",
    "applicationUserId": "account-data-and-transactions-tutorial",
    "institutionId": "modelo-sandbox",
    "status": "AWAITING_AUTHORIZATION",
    "createdAt": "2021-03-04T11:05:17.234Z",
    "featureScope": [
      "ACCOUNT_STATEMENT_FILE",
      "ACCOUNT_STATEMENTS",
      "ACCOUNT_BALANCES",
      "ACCOUNT_SCHEDULED_PAYMENTS",
      "ACCOUNT_STATEMENT",
      "ACCOUNT_TRANSACTIONS_WITH_MERCHANT",
      "ACCOUNT_TRANSACTIONS",

```

--------------------------------

### Get Categorised Transactions Response

Source: https://docs.yapily.com/api-reference/data-plus/get-enrichment-results

Example of a successful response when retrieving categorized transactions. Includes transaction details, enrichment, categorization, and merchant information.

```json
{
  "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"
        }
      }
    ]
  },
  "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"
  }
}
```

--------------------------------

### Error Response Examples

Source: https://docs.yapily.com/api-reference/authorisations/update-payment-pre-authorisation

Examples of error responses that can be returned by the API.

```APIDOC
## Error Response Examples

### Description
Examples of error responses that can be returned by the API.

### Error Response Code 401
```json
{
  "error": {
    "code": 401,
    "status": "UNAUTHORIZED",
    "message": "Full authentication is required to access this resource"
  }
}
```

### General Error Handling
- **400** - Returned by any `POST` endpoint when the body does not conform to the contract.
- **401** - Returned by any endpoint when an invalid `authToken` is used for authentication.
- **403** - Returned by any [Financial Data](/api-reference#financial-data) and any [Payments](/api-reference#payments) endpoint when the `Consent` is no longer authorised to access financial data or to make a payment.
- **404** - Returned by any endpoint where there are path parameters and the path parameters supplied are unable to find the desired resource.
- **409** - Returned by any `POST` endpoint when creating a resource that already exists.
```

--------------------------------

### Create bulk payment authorisation

Source: https://docs.yapily.com/payments/bulk-payments/tutorial-bulk-payment

Initiate the authorization flow by providing the institution ID, callback URL, and payment details.

```bash
curl -L -X POST 'https://api.yapily.com/bulk-payment-auth-requests' \
  -H 'Content-Type: application/json' \
  -u 'APPLICATION_KEY:APPLICATION_SECRET' \
  -d '{
      "applicationUserId": "bulk-payment-tutorial",
      "institutionId": "modelo-sandbox",
      "callback": "https://display-parameters.com/",
      "paymentRequest": {
          "payments": [
              {
                  "type": "DOMESTIC_PAYMENT",
                  "reference": "Payment 1",
                  "paymentIdempotencyId": "{uniqueValue}",
                  "amount": {
                      "amount": 8.70,
                      "currency": "GBP"
                  },
                  "payee": {
                      "name": "BILLS COFFEE LTD",
                      "accountIdentifications": [
                          {
                              "type": "ACCOUNT_NUMBER",
                              "identification": "{accountNumber}"
                          },
                          {
                              "type": "SORT_CODE",
                              "identification": "{sortCode}"
                          }
                      ],
                      "address": {
                          "country": "GB"
                      }
```

--------------------------------

### 400 Error Response Example

Source: https://docs.yapily.com/api-reference/user-beneficiaries/reject-beneficiary

Example of a 400 Bad Request error response.

```APIDOC
### 400 Error Response Example

```json
{
  "error": {
    "tracingId": "0c2d0973bdd24224a65e5d0f7d1b6154",
    "code": 400,
    "status": "BAD_REQUEST",
    "supportUrl": "https://support.yapily.com/",
    "source": "YAPILY",
    "issues": [
      {
        "type": "BAD_REQUEST",
        "code": "10600",
        "message": ""
      }
    ]
  }
}
```
```

--------------------------------

### POST /api/fabrick/psd2/v1/onboarding/{guid} - Live Environment Registration

Source: https://docs.yapily.com/institution-configurations/italy/Soldo

Registers your application in the Fabrick LIVE environment. Requires a valid X.509 certificate for mutual authentication.

```APIDOC
## POST /api/fabrick/psd2/v1/onboarding/{guid}

### Description
Registers your application in the Fabrick LIVE environment. Requires a valid X.509 certificate for mutual authentication.

### Method
POST

### Endpoint
`https://psdgw-onboarding.fabrick.com/api/fabrick/psd2/v1/onboarding/{guid}`

### Parameters
#### Path Parameters
- **guid** (string) - Required - The unique identifier for the onboarding process.

#### Query Parameters
- **token** (string) - Required - Authentication token for the request.

#### Request Headers
- **Content-Type** (string) - Required - Must be 'application/json'.
- **X-Request-ID** (string) - Required - A unique ID for this specific call.

#### Request Body
- **Note:** The request body for the LIVE environment registration is empty.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating successful registration.

#### Response Example
```json
{
  "message": "Live environment registration initiated. You will receive a confirmation email upon certificate validation."
}
```
```

--------------------------------

### Create Bulk Payment Request Example

Source: https://docs.yapily.com/api-reference/payments/create-bulk-payment

Example of a request body for creating a bulk payment, including payment details, idempotency IDs, references, amounts, currencies, and payee information.

```json
{
  "idempotencyId": "1cc3e60d-5500-42be-aaeb-3c5e2f5ed048",
  "payments": [
    {
      "type": "DOMESTIC_PAYMENT",
      "paymentIdempotencyId": "d78fy48uh8f9odhde68dfi38di9",
      "reference": "payment1",
      "contextType": "BILL_IN_ARREARS",
      "purposeCode": "COMT",
      "amount": {
        "amount": 2,
        "currency": "GBP"
      },
      "payee": {
        "name": "Jane Doe",
        "accountIdentifications": [
          {
            "type": "ACCOUNT_NUMBER",
            "identification": "12345678"
          },
          {
            "type": "SORT_CODE",
            "identification": "123456"
          }
        ],
        "accountType": "BUSINESS_SAVING"
      }
    },
    {
      "type": "DOMESTIC_PAYMENT",
      "paymentIdempotencyId": "4279gdy8t63dg73gd8gx87738dg",
      "reference": "payment2",
      "amount": {
        "amount": 5,
        "currency": "GBP"
      },
      "payee": {
        "name": "John Doe",
        "accountIdentifications": [
          {
            "type": "ACCOUNT_NUMBER",
            "identification": "87654321"
          },
          {
            "type": "SORT_CODE",
            "identification": "654321"
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Error Response Example

Source: https://docs.yapily.com/api-reference/financial-data/get-account-statement

An example of a typical error response from the Yapily API.

```APIDOC
## Error Response Example

### Description
This example shows a common error response, indicating an unauthorized access attempt.

### Response Example
```json
{
  "error": {
    "code": 401,
    "status": "UNAUTHORIZED",
    "message": "Full authentication is required to access this resource"
  }
}
```
```
Tokens:
Raw