API de Redsys para PSD2
Endpoint entorno Integracion
Paths
/api-entrada-xs2a/services/{aspsp}/v1.1/accounts
Obtaining list of accounts
This service allows you to obtain a list of PSU accounts, including account balances if required. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. The operation of the service according to the type of access indicated in the consent.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter.
{
"default": false
}Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321
{
"default": "7890-asdf-4321"
}IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET
{
"default": "GET"
}UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
{
"default": "TestTPPCertificate"
}HTTP/1.1 200 Ok
/api-entrada-xs2a/services/{aspsp}/v1.1/accounts/{account-id}
Reading account detail
This service allows you to read the details of an account with the balances if required. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP. The operation of the service according to the type of access indicated in the consent.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter.
{
"default": false
}Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321
{
"default": "7890-asdf-4321"
}IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET
{
"default": "GET"
}UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
{
"default": "TestTPPCertificate"
}HTTP/1.1 200 Ok
/api-entrada-xs2a/services/{aspsp}/v1.1/accounts/{account-id}/transactions
Get the transactions of an account
This service allows to obtain the transactions of an account determined by its identifier. This service allows to obtain the balances of an account determined by its identifier. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Account id
Query start date. It is included if delta access is not required.
Date of end of consultation. Its default value is the current façade if it is not given. Ex: 2017-11-05
If indicated, it would give us the results from the call with transactionId before the given one. Alternative to dateFrom and dateTo
States of returned transactions. The allowed status codes are "booked", "pending", "information" and "both". Mandatory for ASPSPs are "booked."
Indicates that the AISP is in favor of obtaining all transactions after the last report access for this PSU and account. This indicator could be rejected by the ASPSP if this function is not supported.
If included, this function includes balances. This request will be rejected if the access to balances is not collected by consent or the ASPSP does not support this parameter.
{
"default": false
}Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321
{
"default": "7890-asdf-4321"
}IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET
{
"default": "GET"
}UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
{
"default": "TestTPPCertificate"
}HTTP/1.1 200 Ok
/api-entrada-xs2a/services/{aspsp}/v1.1/accounts/{account-id}/balances
Payment balance information
This service allows to obtain the balances of an account determined by its identifier. As a requirement, it is assumed that the PSU has given its consent for this access and has been stored by the ASPSP.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Account id
Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321
{
"default": "7890-asdf-4321"
}IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET
{
"default": "GET"
}UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
{
"default": "TestTPPCertificate"
}HTTP/1.1 200 Ok
/api-entrada-xs2a/services/{aspsp}/v1.1/trusted-beneficiaries
Obtain list of trusted beneficiaries
Obtains the list of trusted beneficiaries of the PSU, who have given explicit consent.
Identificador consumidor APIS
Name of the ASPSP to which you wish to make the request.
Reference to the specific PSU account on which to retrieve the trusted beneficiary listing. Only if supported by the ASPSP.
{
"default": "false"
}Unique identifier of the transaction assigned by the TPP. Ex: X-Request-ID: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7
Bearer Token. Obtained in a previous authentication on Auth2. Ex: Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
{
"default": "Bearer 6yBnsqnMQQ"
}Identifier of the consent on which the account inquiry would go Ex: Consent-ID: 7890-asdf-4321
{
"default": "7890-asdf-4321"
}IP address of the HTPP request between the PSU and the TPP. If not available, the TPP must use the IP address used by the TPP when sending this request. Ex: Ex: PSU-IP-Address: 192.168.16.5
IP port of the HTTP request between the PSU and the TPP if available. Example: PSU-IP-Port: 443
Accept header of the HTTP request between PSU and TPP. Ex: PSU-Accept: application / json
Accept charset header of the HTTP request between PSU and TPP. PSU-Accept-Charset: utf-8
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: en-ES
Accept language header of the HTTP request between PSU and TPP. PSU-Accept-Language: gzip
Browser or operating system of the HTTP request between the PSU and the TPP. Example: PSU-User-Agent: Mozilla / 5.0 (Windows; U; Windows NT 6.1; en-US; rv: 1.9.1.5) Gecko / 20091102 Firefox / 3.5.5 (.NET CLR 3.5.30729)
HTTP method used in the interface between PSU and TPP. Allowed values: GET, POST, PUT, PATCH, DELETE. Ex: PSU-Http-Method: GET
{
"default": "GET"
}UUID (Universally Unique Identifier) for a device. The UUID identifies the device or an installation of an application on a device. This ID should not be modified until the device application is uninstalled. Ex: PSU-Device-ID: 5b3ab8e8-0fd5-43d2-946e-d75958b172e7
Location corresponding to the HTTP request between the PSU and the TPP. Ex: PSU-Geo-Location: GEO: 90.023856; 25.345963
It is content if the Signature field travels. Ex: Digest: SHA-256 = NzdmZjA4YjY5M2M2NDYyMmVjOWFmMGNmYTZiNTU3MjVmNDI4NTRlMzJkYzE3ZmNmMDE3ZGFmMjhhNTc5OTU3OQ ==
Signature of the petition by the TPP.
TPP certificate used to sign the petition, in base64, without header, footer or line breaks. Ex: TPP-Signature-Certificate: MIIHgzCCBmugAwIBAgIIZzZvBQlt0UcwDQYJ ………… .KoZIhvcNAQELBQAwSTELMAkGA1UEBhMCVVMxEzARBgNVBA
{
"default": "TestTPPCertificate"
}HTTP/1.1 200 OK
Definitions
{
"type": "object",
"properties": {
"booked": {
"$ref": "#\/definitions\/List_Transactions",
"description": "Últimas transacciones (anotaciones) conocidas de la cuenta.",
"x-ibm-languages": {
"description": {
"en": "Last known transactions (annotations) of the account."
}
}
},
"pending": {
"$ref": "#\/definitions\/List_Transactions",
"description": "Transacciones pendientes de la cuenta.",
"x-ibm-languages": {
"description": {
"en": "Pending account transactions."
}
}
},
"information": {
"$ref": "#\/definitions\/List_Transactions",
"description": "Listado de órdenes permanentes. Incluido si el parámetro bookingStatus está establecido a \"information\"",
"x-ibm-languages": {
"description": {
"en": "List of standing orders. Included if the bookingStatus parameter is set to \"information\""
}
}
},
"_links": {
"description": "Cuenta del beneficiario",
"x-ibm-languages": {
"description": {
"en": "Beneficiary account"
}
},
"example": "",
"$ref": "#\/definitions\/Links"
}
}
}
{
"type": "object",
"properties": {
"iban": {
"type": "string",
"example": "ES1111111111111111111111"
},
"bban": {
"type": "string",
"example": "20385778983000760236"
},
"pan": {
"type": "string",
"example": "1234567891234567"
},
"masked_pan": {
"type": "string",
"example": "123456******4567"
},
"msisdn": {
"type": "string",
"example": "12414515"
},
"currency": {
"type": "string",
"example": "EUR"
}
}
}
{
"properties": {
"resourceId": {
"type": "string",
"example": "3dc3d5b3702348489853f5400a64e80f",
"description": "Identificador de la cuenta a ser usado en el PATH cuando se solicitan datos sobre una cuenta dedicada.",
"x-ibm-languages": {
"description": {
"en": "Identifier of the account to be used in the PATH when data is requested on a dedicated account."
}
}
},
"iban": {
"type": "string",
"example": "ES1111111111111111111",
"description": "IBAN de la cuenta",
"x-ibm-languages": {
"description": {
"en": "Account IBAN"
}
}
},
"bban": {
"type": "string",
"description": "BBAN de la cuenta, cuando esta no tiene IBAN.",
"x-ibm-languages": {
"description": {
"en": "Account BBAN, when it does not have IBAN."
}
},
"example": "20385778983000760236"
},
"msisdn": {
"type": "string",
"description": "Alias para acceder a una cuenta de pago a través de un número de teléfono móvil registrado.",
"x-ibm-languages": {
"description": {
"en": "Alias to access a payment account through a registered mobile phone number."
}
},
"example": "8198741987"
},
"currency": {
"type": "string",
"description": "Tipo de moneda",
"x-ibm-languages": {
"description": {
"en": "Currency type"
}
},
"example": "EUR"
},
"name": {
"type": "string",
"description": "Nombre dado por el banco o el PSU a la cuenta en la banca online.",
"x-ibm-languages": {
"description": {
"en": "Name given by the bank or PSU to the account in online banking."
}
},
"example": "Nombre"
},
"product": {
"type": "string",
"description": "Nombre del producto que da el ASPSP a esta cuenta.",
"x-ibm-languages": {
"description": {
"en": "Name of the product that the ASPSP gives to this account."
}
},
"example": "Main Account"
},
"cashAccountType": {
"type": "string",
"description": "Especifica la naturaleza o el uso de la cuenta.",
"x-ibm-languages": {
"description": {
"en": "Specify the nature or use of the account."
}
},
"example": "BBAN"
},
"status": {
"type": "string",
"description": "Estado de la cuenta. El valor es uno de los siguientes: enabled, deleted, blocked",
"x-ibm-languages": {
"description": {
"en": "Account status. The value is one of the following: enabled, deleted, blocked "
}
},
"example": "enabled"
},
"bic": {
"type": "string",
"description": "BIC de la cuenta.",
"x-ibm-languages": {
"description": {
"en": "BIC of the account."
}
},
"example": "XSXHXSMMXXX"
},
"usage": {
"type": "string",
"description": "Especifica el uso de la cuenta. Valores posibles: PRIV (cuenta personal privada), ORGA (cuenta profesional)",
"x-ibm-languages": {
"description": {
"en": "Specify the use of the account. Possible values: PRIV (private personal account), ORGA (professional account) "
}
},
"example": "PRIV"
},
"details": {
"type": "string",
"description": "Especificaciones que deben ser provistas por el ASPSP. Características de la cuenta, características de la tarjeta",
"x-ibm-languages": {
"description": {
"en": "Specifications that must be provided by the ASPSP. Account features, card features"
}
}
},
"balances": {
"description": "Balances de la cuenta",
"x-ibm-languages": {
"description": {
"en": "Account balances"
}
},
"$ref": "#\/definitions\/List_Balance"
},
"_links": {
"description": "Enlaces a la cuenta para recuperar información de balances y\/o transacciones de la cuenta. Links soportados solo cuando se ha dado el consentimiento correspondiente a la cuenta.",
"x-ibm-languages": {
"description": {
"en": "Links to the account to retrieve balance information and \/ or account transactions. Supported links only when the corresponding consent has been given to the account."
}
},
"$ref": "#\/definitions\/Links"
},
"ownerName": {
"type": "string",
"description": "Nombre del propietario legal de la cuenta. Si hay más de un propietario, entonces en este campo deberán informarse los nombres. Para una cuenta corporativa, el nombre corporativo se usará en este campo.",
"x-ibm-languages": {
"description": {
"en": "Name of the legal owner of the account. If there is more than one owner, then in this field the names must be informed. For a corporate account, the corporate name will be used in this field. "
}
},
"example": "Nombre del propietario"
},
"ownerNames": {
"description": "Listado de nombres de propietarios de la cuenta.",
"x-ibm-languages": {
"description": {
"en": "List of names of account owners."
}
},
"additionalProperties": {
"$ref": "#\/definitions\/AccountOwner"
}
},
"psuName": {
"type": "string",
"description": "Nombre del PSU conectado.En caso de cuentas corporativas, esto podría ser la persona que actúe en nombre de la empresa.",
"x-ibm-languages": {
"description": {
"en": "Name of the connected PSU. In case of corporate accounts, this could be the person acting on behalf of the company."
}
},
"example": "Heike Mustermann"
}
},
"additionalProperties": true,
"required": [
"currency"
]
}
{
"type": "object",
"properties": {
"name": {
"description": "Nombre propietario de la cuenta.",
"x-ibm-languages": {
"description": {
"en": "Account owner name."
}
}
},
"role": {
"description": "Los siguientes códigos de propietarios son usados: \"owner\",\"legalRepresentative\",\"authorisedUser\"",
"x-ibm-languages": {
"description": {
"en": "The following owner codes are used: \"owner\", \"legalRepresentative\", \"authorizedUser\"."
}
}
}
},
"additionalProperties": true,
"required": [
"name"
]
}
{
"type": "object",
"properties": {
"currency": {
"type": "string",
"example": "EUR"
},
"content": {
"type": "string",
"example": "150.03"
}
}
}
{
"properties": {
"balanceAmount": {
"$ref": "#\/definitions\/Amount",
"description": "Importe y moneda del balance",
"x-ibm-languages": {
"description": {
"en": "Balance amount and currency"
}
}
},
"balanceType": {
"description": "Transacciones compuestas por las entradas anotadas y las entradas pendientes en el momento de la petición.",
"x-ibm-languages": {
"description": {
"en": "Transactions composed of the entries entered and the pending entries at the time of the request."
}
},
"type": "string",
"example": "closingBooked"
},
"creditLimitIncluded": {
"description": "Flag indicando si el límite de crédito de la cuenta correspondiente está incluido en el cálculo del balance, cuando aplicque.",
"x-ibm-languages": {
"description": {
"en": "Flag indicating if the credit limit of the corresponding account is included in the balance calculation, when applicable."
}
},
"type": "boolean",
"example": "true"
},
"lastChangeDateTime": {
"description": "Fecha de la última acción realizada sobre la cuenta.",
"x-ibm-languages": {
"description": {
"en": "Date of the last action performed on the account."
}
},
"type": "string",
"example": "2017-10-25T15:30:35.035Z"
},
"referenceDate": {
"type": "string",
"description": "Fecha de referencia del balance",
"x-ibm-languages": {
"description": {
"en": "Balance sheet reference date"
}
},
"example": "2017-10-25"
},
"lastCommittedTransaction": {
"type": "string",
"description": "entryReference de la última transacción para ayudar al TPP a identificar si ya se conocen todas las transacciones del PSU.",
"x-ibm-languages": {
"description": {
"en": "entryReference of the last transaction to help the TPP identify if all transactions of the PSU are already known."
}
},
"example": "1234-asd-567"
}
},
"additionalProperties": false
}
{
"properties": {
"href": {
"type": "string",
"description": "Contiene un enlace a un recurso",
"example": "\/v1.1\/payments\/sepa-credit-transfers\/asd-1234-jkl"
}
}
}
{
"properties": {
"scaRedirect": {
"$ref": "#\/definitions\/Href"
},
"scaOAuth": {
"$ref": "#\/definitions\/Href"
},
"startAuthorisation": {
"$ref": "#\/definitions\/Href"
},
"startAuthorisationWithAuthenticationMethodSelection": {
"$ref": "#\/definitions\/Href"
},
"selectAuthenticationMethod": {
"$ref": "#\/definitions\/Href"
},
"self": {
"$ref": "#\/definitions\/Href"
},
"status": {
"$ref": "#\/definitions\/Href"
},
"scaStatus": {
"$ref": "#\/definitions\/Href"
},
"account": {
"$ref": "#\/definitions\/Href"
},
"balances": {
"$ref": "#\/definitions\/Href"
},
"transactions": {
"$ref": "#\/definitions\/Href"
},
"first": {
"$ref": "#\/definitions\/Href"
},
"next": {
"$ref": "#\/definitions\/Href"
},
"previous": {
"$ref": "#\/definitions\/Href"
},
"last": {
"$ref": "#\/definitions\/Href"
},
"download": {
"$ref": "#\/definitions\/Href"
}
}
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/AccountDetails"
}
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Transactions"
}
}
{
"type": "array",
"items": {
"$ref": "#\/definitions\/Balance"
}
}
{
"properties": {
"currencyFrom": {
"type": "string",
"description": "Moneda Origen",
"x-ibm-languages": {
"description": {
"en": "Currency Origin"
}
},
"example": "USD"
},
"rate": {
"type": "string",
"description": "Define la tarifa de intercambio. Ej: currencyFrom=USD, currencyTo=EUR: 1USD =0.8 EUR y 0.8 es la tarifa.",
"x-ibm-languages": {
"description": {
"en": "Define the exchange rate. Ex: currencyFrom = USD, currencyTo = EUR: 1USD = 0.8 EUR and 0.8 is the rate. "
}
},
"example": "0.8"
},
"currencyTo": {
"type": "string",
"description": "Moneda Destino",
"x-ibm-languages": {
"description": {
"en": "Destination Currency"
}
},
"example": "EUR"
},
"rateDate": {
"type": "string",
"description": "Fecha de la tarifa. Formato ISODateTime",
"x-ibm-languages": {
"description": {
"en": "Rate date. ISODateTime format"
}
}
},
"rateContract": {
"type": "string",
"description": "Referencia al contrato de la tarifa",
"x-ibm-languages": {
"description": {
"en": "Reference to the tariff contract"
}
}
}
},
"additionalProperties": false,
"required": [
"currencyFrom",
"rate",
"currencyTo",
"rateDate"
]
}
{
"properties": {
"trustedBeneficiaries": {
"$ref": "#\/definitions\/TrustedBeneficiary",
"description": "Este reporte contiene todos los beneficarios de confianza del PSU para aquellas cuentas que fueron consentidas. Este array podría devolverse vacío.",
"example": "trustedBeneficiaries: […]"
},
"psuMessage": {
"type": "string",
"description": "Texto enviado al TPP a través del HUB para ser mostrado al PSU.",
"example": "psuMessage: Información para PSU"
},
"tppMessages": {
"$ref": "#\/definitions\/TppMessage",
"description": "Mensaje para el TPP enviado a través del HUB.",
"example": "tppMessages: […]"
}
}
}
{
"properties": {
"psuMessage": {
"type": "string",
"description": "Mensaje PSU",
"x-ibm-languages": {
"description": {
"en": "PSU message"
}
},
"example": "Mensaje PSU"
},
"tppMessage": {
"$ref": "#\/definitions\/TppMessage",
"description": "Mensaje para el TPP",
"x-ibm-languages": {
"description": {
"en": "Message for the TPP"
}
}
},
"accounts": {
"$ref": "#\/definitions\/List_AccountDetails",
"description": "Listado de cuentas disponibles.",
"x-ibm-languages": {
"description": {
"en": "List of available accounts."
}
}
}
},
"required": [
"accounts"
]
}
{
"type": "object",
"properties": {
"psuMessage": {
"type": "string",
"description": "Mensaje PSU",
"x-ibm-languages": {
"description": {
"en": "PSU message"
}
},
"example": "Mensaje PSU"
},
"tppMessage": {
"$ref": "#\/definitions\/TppMessage",
"description": "Mensaje para el TPP",
"x-ibm-languages": {
"description": {
"en": "Message for the TPP"
}
}
},
"account": {
"$ref": "#\/definitions\/AccountReference",
"description": "Identificador de la cuenta que se está consultando.",
"x-ibm-languages": {
"description": {
"en": "Identifier of the account being consulted."
}
}
},
"transactions": {
"$ref": "#\/definitions\/AccountReport",
"description": "Devolución de los datos en formato JSON, cuando los datos devueltos tienen un tamaño pequeño.",
"x-ibm-languages": {
"description": {
"en": "Return of data in JSON format, when the returned data has a small size."
}
}
},
"balances": {
"$ref": "#\/definitions\/List_Balance",
"description": "Una lista de balances con respecto a una cuenta.",
"x-ibm-languages": {
"description": {
"en": "A list of balances regarding an account."
}
}
},
"_links": {
"$ref": "#\/definitions\/Links"
}
}
}
{
"properties": {
"psuMessage": {
"type": "string",
"description": "Mensaje PSU",
"x-ibm-languages": {
"description": {
"en": "PSU message"
}
},
"example": "Mensaje PSU"
},
"tppMessage": {
"$ref": "#\/definitions\/TppMessage",
"description": "Mensaje para el TPP",
"x-ibm-languages": {
"description": {
"en": "Message for the TPP"
}
}
},
"balances": {
"description": "Balances de la cuenta",
"x-ibm-languages": {
"description": {
"en": "Account balances"
}
},
"$ref": "#\/definitions\/List_Balance"
},
"account": {
"$ref": "#\/definitions\/AccountReference",
"description": "Identificador de la cuenta que se está consultando.",
"x-ibm-languages": {
"description": {
"en": "Identifier of the account being consulted."
}
}
}
},
"required": [
"balances"
]
}
{
"properties": {
"psuMessage": {
"type": "string",
"description": "Texto a mostrar al PSU",
"x-ibm-languages": {
"description": {
"en": "Text to display to the PSU"
}
},
"example": "Texto para mostrar"
},
"tppMessage": {
"$ref": "#\/definitions\/TppMessage",
"description": "Mensaje para el TPP",
"x-ibm-languages": {
"description": {
"en": "Message for the TPP"
}
}
},
"account": {
"$ref": "#\/definitions\/AccountDetails",
"description": "Información detallada de la cuenta",
"x-ibm-languages": {
"description": {
"en": "Detailed account information"
}
}
}
},
"required": [
"account"
]
}
{
"properties": {
"startDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"executionRule": {
"type": "string"
},
"withinAMonthFlag": {
"type": "boolean"
},
"frequency": {
"type": "string"
},
"monthsOfExecution": {
"type": "array",
"items": {
"type": "string"
}
},
"multiplicator": {
"type": "integer"
},
"dayOfExecution": {
"type": "string"
},
"limitAmount": {
"$ref": "#\/definitions\/Amount"
}
},
"required": [
"startDate",
"frequency"
]
}
{
"properties": {
"standingOrderDetails": {
"$ref": "#\/definitions\/StandingOrderDetails"
}
}
}
{
"properties": {
"trustedBeneficiaryId": {
"type": "string",
"description": "Recurso identificador de la entrada en la lista.",
"example": "trustedBeneficiaryId: 1b3ab8e8-0fd5-43d2-946e-d75958b172e7"
},
"debtorAccount": {
"$ref": "#\/definitions\/AccountReference",
"description": "Proporcionado por el ASPSP si la entrada del beneficiario de confianza es aplicable solo a una cuenta específica."
},
"creditorAccount": {
"$ref": "#\/definitions\/AccountReference",
"description": "Cuenta del beneficiario"
},
"creditorAgent": {
"type": "string",
"description": "Obligatorio cuando la información es obligatoria para la transferencia de crédito relacionada. Por ej. pagos fuera de la zona SEPA."
},
"creditorName": {
"type": "string",
"description": "Nombre del beneficiario como lo proporcionó el PSU."
},
"creditorAlias": {
"type": "string",
"description": "Alias definido por el PSU que es mostrado en mostrado en el listado de beneficiarios de confianza de los canales online del ASPSP."
}
}
}
{
"properties": {
"transactionId": {
"type": "string",
"description": "Identificador de la transacción. Puede ser usado como access-ID en la API, donde más detalles sobre la transación pueden ser ofrecidos. Si este dato es proporcionado se puede tener acceso a la petición de detalles de transacción.",
"x-ibm-languages": {
"description": {
"en": "Transaction identifier. It can be used as access-ID in the API, where more details about the transaction can be provided. If this data is provided you can access the transaction details request."
}
}
},
"endToEndId": {
"type": "string",
"description": "Identificador único end to end",
"x-ibm-languages": {
"description": {
"en": "Unique identifier end to end"
}
}
},
"entryReference": {
"type": "string",
"description": "Identificación de la transacción que puede ser usada, por ejemplo, en las consultas delta.",
"x-ibm-languages": {
"description": {
"en": "Identification of the transaction that can be used, for example, in delta queries."
}
}
},
"mandateId": {
"type": "string",
"description": "Identificación del mandato. Por ejemplo, un ID de un mandato SEPA.",
"x-ibm-languages": {
"description": {
"en": "Identification of the mandate. For example, an ID of a SEPA command. "
}
},
"example": "e733223hge7"
},
"checkId": {
"type": "string",
"description": "Identificador de un cheque",
"x-ibm-languages": {
"description": {
"en": "Identifier of a check"
}
}
},
"creditorId": {
"type": "string",
"description": "Identificación del beneficiario. Por ejemplo, un ID de beneficiario SEPA.",
"x-ibm-languages": {
"description": {
"en": "Beneficiary identification. For example, a SEPA beneficiary ID. "
}
},
"example": "e7363987hge7"
},
"bookingDate": {
"type": "string",
"description": "Fecha de anotación de la transacción",
"x-ibm-languages": {
"description": {
"en": "Transaction annotation date"
}
},
"example": "2017-10-23"
},
"valueDate": {
"type": "string",
"description": "Fecha valor de la transacción",
"x-ibm-languages": {
"description": {
"en": "Transaction value date"
}
},
"example": "2017-10-23"
},
"transactionAmount": {
"$ref": "#\/definitions\/Amount",
"description": "Cantidad de la transaccion",
"x-ibm-languages": {
"description": {
"en": "Transaction amount"
}
}
},
"currencyExchange": {
"$ref": "#\/definitions\/ExchangeRate",
"description": "Tasa de intercambio",
"x-ibm-languages": {
"description": {
"en": "Exchange rate"
}
}
},
"creditorName": {
"type": "string",
"description": "Nombre del beneficiario si la transacción es un cargo.",
"x-ibm-languages": {
"description": {
"en": "Name of the beneficiary if the transaction is a charge."
}
},
"example": "NombreEjemplo"
},
"creditorAccount": {
"description": "Cuenta del beneficiario.",
"x-ibm-languages": {
"description": {
"en": "Beneficiary account."
}
},
"$ref": "#\/definitions\/AccountReference"
},
"creditorAgent": {
"type": "string",
"description": "BIC de la cuenta del beneficiario.",
"x-ibm-languages": {
"description": {
"en": "BIC of the beneficiary's account."
}
},
"example": "\"creditorAgent\": \"XXXSDH\""
},
"ultimateCreditor": {
"type": "string",
"description": "Beneficiario final.",
"x-ibm-languages": {
"description": {
"en": "Final beneficiary."
}
}
},
"debtorName": {
"type": "string",
"description": "Nombre del ordenante",
"x-ibm-languages": {
"description": {
"en": "Name of the payer"
}
},
"example": "NombreEjemplo"
},
"debtorAccount": {
"description": "Cuenta del ordenante.",
"x-ibm-languages": {
"description": {
"en": "Account of the payer."
}
},
"$ref": "#\/definitions\/AccountReference"
},
"debtorAgent": {
"type": "string",
"description": "BIC asociado al ASPSP ordenante.",
"x-ibm-languages": {
"description": {
"en": "BIC associated to the ordering ASPSP."
}
}
},
"ultimateDebtor": {
"type": "string",
"description": "Nombre ordenante final.",
"x-ibm-languages": {
"description": {
"en": "Final ordering name."
}
},
"example": "NombreEjemplo"
},
"remittanceInformationUnstructured": {
"type": "string",
"description": "Campo para incluir información adicional del envío.",
"x-ibm-languages": {
"description": {
"en": "Field to include additional shipping information."
}
},
"example": "Informacion adicional"
},
"remittanceInformationUnstructuredArray": {
"type": "array",
"items": {
"type": "string"
},
"description": "Nota: en la versión 2 del estándar los dos remittanceUnstructured podrían unirse en uno solo",
"x-ibm-languages": {
"description": {
"en": "Note: in version 2 of the standard the two remittanceUnstructured could be merged into one"
}
}
},
"remittanceInformationStructured": {
"type": "string",
"description": "Campo para incluir una referencia",
"x-ibm-languages": {
"description": {
"en": "Field to include a reference"
}
},
"example": "1234-asdf-456"
},
"remittanceInformationStructuredArray": {
"type": "array",
"items": {
"type": "string"
},
"description": "Nota: en la versión 2 del estándar los dos remittanceUnstructured podrían unirse en uno solo",
"x-ibm-languages": {
"description": {
"en": "Note: in version 2 of the standard the two remittanceUnstructured could be merged into one"
}
}
},
"additionalInformation": {
"type": "string",
"description": "Usado por el TPP para transportar información adicional del PSU",
"x-ibm-languages": {
"en": "Used by the TPP to carry additional PSU information"
}
},
"additionalInformationStructured": {
"description": "Es usado solo si el campo bookingStatus contiene el valor \"information\". Cada orden permanente activa relacionada a la cuenta de pago resulta en una entrada.",
"x-ibm-languages": {
"description": {
"en": "It is used only if the bookingStatus field contains the value \"information\". Each active standing order related to the payment account results in one entry."
}
},
"$ref": "#\/definitions\/StructuredAdditionalInformation"
},
"purposeCode": {
"type": "string",
"description": "ExternalPurpose1Code ISO 20022"
},
"proprietaryBankTransactionCode": {
"type": "string",
"description": "Código de transacción propietario del banco",
"x-ibm-languages": {
"en": "Bank proprietary transaction code"
}
},
"bankTransactionCode": {
"type": "string",
"description": "Códigos de transacción bancaria usados por el ASPSP y usando los sub-elementos de los códigos estructurados definidos en ISO 20022",
"x-ibm-languages": {
"description": {
"en": "Bank transaction codes used by the ASPSP and using the sub-elements of the structured codes defined in ISO 20022"
}
}
},
"balanceAfterTransaction": {
"description": "Saldo después de la transacción. Balance recomendado es interimBooked",
"x-ibm-languages": {
"en": "Balance after transaction. Recommended balance is interimBooked"
},
"$ref": "#\/definitions\/Balance"
},
"_links": {
"description": "Valores posibles: • transactionDetails",
"x-ibm-languages": {
"en": "Possible values: - transactionDetails"
}
}
}
}
{
"properties": {
"category": {
"type": "string",
"example": "OK"
},
"code": {
"type": "string",
"example": "ACCESS_OK"
},
"text": {
"type": "string",
"example": "Acceso OK"
},
"path": {
"type": "string",
"example": "\/example\/path"
}
},
"additionalProperties": false
}