Accounts

The Accounts API gives you access to details, transactions and balances for accounts, all within the scope of a granted consent.

The following diagram illustrates the process flow for account information access using our API in compliance with PSD2. The process involves several stages, including user authentication, consent creation, authorization and verification.

snappi

GET/v1/accounts

Fetch accounts list

Retrieve a list of accounts associated with a specific user or entity. Access detailed information about each account, including account numbers, currency, balance details and more.

Query parameters

  • Name
    withBalance
    Type
    boolean
    Description

    If included, this function reads the list of accessible payment accounts, including the booking balance. This is only granted if the PSU has given consent in the related consent and if it is available from the ASPSP.

    The ASPSP might choose to ignore this parameter.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate used for signature verification.

  • Name
    ClientId
    Type
    string
    Description

    The client ID associated with the request.

  • Name
    consentID
    Type
    string
    Description

    The consentId of the related consent, which was performed prior to this payment initiation.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response atrributes

  • Name
    accounts
    Type
    array
    Description

    A list of all the accounts associated. Each account includes:

    • iban: The International Bank Account Number (IBAN) associated with the account.
    • bban: The Basic Bank Account Number (BBAN) associated with the account.
    • pan: The Primary Account Number (PAN) associated with the account.
    • maskedPan: The masked Primary Account Number associated with the account.
    • msisdn: The Mobile Station International Subscriber Directory Number (MSISDN) associated with the account.
    • currency: The currency in which the account operates.
    • resourceId: The resource identifier of the account.
    • name: The name of the account.
    • product: The type of product that the account is associated with.
    • cashAccountType: The type of cash account.
    • status: The status of the account, indicating whether the account is active or not (integer). Available values: 0 = enabled, 1 = deleted, 2 = blocked.
    • bic: The Bank Identifier Code (BIC) object that identifies the bank that the account is held with.
    • linkedAccounts: A list of all the linked accounts associated with the account.
    • usage: The usage of the account (integer). Available values: 0 = PRIV (private), 1 = ORGA (organisation).
    • details: A list of all the details associated with the account.
    • balances: Balances associated with the account, each including:
      • balanceAmount: The amount of funds available for the given balance type. It includes:
        • currency: The currency of the balance amount.
        • Amount: The amount of funds available for the given balance type.
      • balanceType: The type of the balance. Available values:
        • 0 = closingBooked
        • 1 = expected
        • 2 = authorised
        • 3 = openingBooked
        • 4 = interimAvailable
        • 5 = interimBooked
        • 6 = forwardAvailable
        • 7 = nonInvoiced
      • creditLimitIncluded: Indicates whether the credit limit is included in the balance.
      • lastChangeDateTime: The date and time of the last change made to the account details.
      • referenceDate: The date for which the account information is retrieved.
      • lastCommittedTransaction: Information about the last committed transaction on the account.
  • Name
    links
    Type
    object
    Description

    The links parameter provides links to related resources or endpoints that are associated with the account. These links can be used to navigate to additional information or perform specific actions related to the account.

  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the consent information.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent. It includes:

    • items (object): The list of items related to the consent information.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the response.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category : The message category of the error. Available options: 0 = ERROR, 1 = WARNING.
    • code : The code of the error.
    • path : The path associated with the error.
    • text : The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
/v1/accounts
curl -X GET /v1/accounts \
-H 'Accept: application/json' \
-H 'X-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'consentID: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"accounts": [
{
  "iban": "",
  "bban": "",
  "pan": "",
  "maskedPan": "",
  "msisdn": "",
  "currency": "",
  "resourceId": "",
  "name": "",
  "product": "",
  "cashAccountType": "",
  "status": 0,
  "bic": "",
  "linkedAccounts": "",
  "usage": 0,
  "details": "",
  "balances": [
    {
      "balanceAmount": {
        "currency": "",
        "Amount": ""
      },
      "balanceType": 0,
      "creditLimitIncluded": false,
      "lastChangeDateTime": "",
      "referenceDate": "",
      "lastCommittedTransaction": ""
    }
  ],
  "links": ""
}
]
}

Responses

StatusDescription
200OK
400Bad Request
401Unauthorised
403Forbidden
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests
GET/v1/accounts/{accountId}

Fetch account details

Retrieve a list of accounts associated with a specific user or entity. Access detailed information about each account, including account numbers, currency, balance details and more.

Path parameters

  • Name
    account-id
    Type
    string
    Description

    The unique identifier of the account.

Query parameters

  • Name
    withBalance
    Type
    boolean
    Description

    If included, this function reads the list of accessible payment accounts, including the booking balance. This is only granted if the PSU has given consent in the related consent and if it is available from the ASPSP.

    The ASPSP might choose to ignore this parameter.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate used for signature verification.

  • Name
    ClientId
    Type
    string
    Description

    The client ID associated with the request.

  • Name
    consentID
    Type
    string
    Description

    The consentId of the related consent, which was performed prior to this payment initiation.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response atrributes

  • Name
    iban
    Type
    string
    Description

    The International Bank Account Number (IBAN) associated with the account.

  • Name
    bban
    Type
    string
    Description

    The Basic Bank Account Number (BBAN) associated with the account.

  • Name
    pan
    Type
    string
    Description

    The Primary Account Number (PAN) associated with the account. The PAN is not necessarily a globally unique identifier, but is a value that can be used for a unique account identification.

  • Name
    maskedPan
    Type
    string
    Description

    The masked PAN associated with the account.

  • Name
    msisdn
    Type
    string
    Description

    The Mobile Station International Subscriber Directory Number (MSISDN) associated with the account.

  • Name
    currency
    Type
    string
    Description

    The currency associated with the account.

  • Name
    resourceId
    Type
    string
    Description

    The resource ID associated with the account.

  • Name
    name
    Type
    string
    Description

    The name associated with the account.

  • Name
    product
    Type
    string
    Description

    The product associated with the account.

  • Name
    cashAccountType
    Type
    string
    Description

    The type of the cash account associated with the account.

  • Name
    status
    Type
    integer
    Description

    The status of the account. Available values: 0, 1, 2. Possible values:

    • 0 = enabled
    • 1 = deleted
    • 2 = blocked
  • Name
    bic
    Type
    string
    Description

    The Bank Identifier Code (BIC) associated with the account.

  • Name
    linkedAccounts
    Type
    string
    Description

    The linked accounts associated with the account.

  • Name
    usage
    Type
    integer
    Description

    The usage of the account. Available values: 0, 1. Available values: 0 = PRIV (private), 1 = ORGA (organisation).

  • Name
    details
    Type
    string
    Description

    The details associated with the account.

  • Name
    balances
    Type
    array
    Description

    An array of balance objects, each containing:

    • balanceAmount: The amount of funds available for the given balance type (object). It includes:
      • currency: The currency of the balance amount.
      • Amount: The amount of the balance.
    • balanceType: The type of the balance associated with the account. Available options: 0 - 7.
      • 0 - Available balance.
      • 1 - Current balance.
      • 2 - Credit limit.
      • 3 - Credit available.
      • 4 - Credit held for payout.
      • 5 - Credit available for payout.
      • 6 - Credit limit for payout.
      • 7 - Credit available for immediate payout.
    • creditLimitIncluded: Indicates whether the credit limit is included in the account details information.
    • lastChangeDateTime: Contains the date and time of the last change made to the account details.
    • referenceDate: Specifies the date for which the account information is retrieved.
    • lastCommittedTransaction: The last committed transaction associated with the account.
  • Name
    links
    Type
    object
    Description

    The links parameter provides links to related resources or endpoints that are associated with the account. These links can be used to navigate to additional information or perform specific actions related to the account.

  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the account information.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent. It includes:

    • items (object): The list of items related to the consent information.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the response.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0 = ERROR, 1 = WARNING.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
/v1/accounts/{account-id}
curl -X GET /v1/accounts/{account-id} \
-H 'Accept: application/json' \
-H 'X-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'consentID: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"iban": "",
"bban": "",
"pan": "",
"maskedPan": "",
"msisdn": "",
"currency": "",
"resourceId": "",
"name": "",
"product": "",
"cashAccountType": "",
"status": 0,
"bic": "",
"linkedAccounts": "",
"usage": 0,
"details": "",
"balances": [
{
  "balanceAmount": {
    "currency": "",
    "Amount": ""
  },
  "balanceType": 0,
  "creditLimitIncluded": false,
  "lastChangeDateTime": "",
  "referenceDate": "",
  "lastCommittedTransaction": ""
}
],
"links": ""
}

Responses

StatusDescription
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests
GET/v1/accounts/{account-id}/balances

Fetch account balance

Retrieve balance information for a given account addressed by account-id. Access various details such as currency, balance amount and transaction information.

Path parameters

  • Name
    account-id
    Type
    string
    Description

    The account-id is retrieved by the Fetch accounts list call and is constant at least throughout the lifecycle of a given consent.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate used for signing the request, in base64 encoding.

  • Name
    ClientId
    Type
    string
    Description

    The ID of the client at the TPP.

  • Name
    consentID
    Type
    string
    Description

    The consentId of the related AIS consent, which was performed prior to this payment initiation.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response atrributes

  • Name
    account
    Type
    object
    Description

    The account information associated with the balance. Each account includes:

    • iban: The International Bank Account Number (IBAN) associated with the account.
    • bban: The Basic Bank Account Number (BBAN) associated with the account.
    • pan: The Primary Account Number (PAN) associated with the account.
    • maskedPan: The masked Primary Account Number associated with the account.
    • msisdn: The Mobile Station International Subscriber Directory Number (MSISDN) associated with the account.
    • currency: The currency in which the account operates.
  • Name
    balances
    Type
    object
    Description

    An array of balance objects, each containing:

    • balanceAmount: The amount of funds available for the given balance type. It includes:
      • currency: The currency of the balance amount.
      • Amount: The amount of funds available for the given balance type.
    • balanceType: The type of the balance. Available options: 0 - 7.
      • 0: Balance type is unknown.
      • 1: Balance type is a current balance.
      • 2: Balance type is a credit limit.
      • 3: Balance type is a credit available.
      • 4: Balance type is a savings balance.
      • 5: Balance type is a savings available.
      • 6: Balance type is a credit limit and a savings balance.
      • 7: Balance type is a credit limit and a savings available.
    • creditLimitIncluded: Indicates whether the credit limit is included in the balance.
    • lastChangeDateTime: The date and time of the last change made to the account details.
    • referenceDate: The date for which the account information is retrieved.
    • lastCommittedTransaction: Information about the last committed transaction on the account.
  • Name
    links
    Type
    object
    Description

    The links parameter provides links to related resources or endpoints that are associated with the account. These links can be used to navigate to additional information or perform specific actions related to the account.

  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the balance information.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent. It includes:

    • items (object): The list of items related to the consent information.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the response.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
      • 0: The message category is unknown.
      • 1: The message category is information.
    • code (integer): The code of the error. Available options:
      • 0: The code is unknown.
      • 1: The code is generic.
      • 2: The code is invalid.
      • 3: The code is invalid consent.
      • 4: The code is invalid consent state.
      • 5: The code is invalid account access.
      • 6: The code is invalid consent type.
      • 7: The code is invalid consent frequency.
      • 8: The code is invalid consent execution date.
      • 9: The code is invalid consent execution frequency.
      • 10: The code is invalid consent amount.
      • 11: The code is invalid consent currency.
      • 12: The code is invalid consent account.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
/v1/accounts/{account-id}/balances
curl -X GET /v1/accounts/{account-id}/balances \
-H 'Accept: application/json' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'x-Request-ID: string' \
-H 'consentID: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"account": {
"iban": "",
"bban": "",
"pan": "",
"maskedPan": "",
"msisdn": "",
"currency": ""
},
"balances": [
{
  "balanceAmount": {
    "currency": "",
    "Amount": ""
  },
  "balanceType": 0,
  "creditLimitIncluded": false,
  "lastChangeDateTime": "",
  "referenceDate": "",
  "lastCommittedTransaction": ""
}
]
}

Responses

StatusDescription
200OK
400Bad Request
401Unauthorised
403Forbidden
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests
GET/v1/accounts/{account-id}/transactions?bookingStatus=string

Fetch account transactions

Retrieve a list of transactions associated with a specific account.

Access detailed information such as transaction IDs, dates, amounts, creditor / debtor details and balance amounts.

Path parameters

  • Name
    account-id
    Type
    string
    Description

    The account-id is retrieved by the Fetch accounts list call and is constant at least throughout the lifecycle of a given consent.

Query parameters

  • Name
    bookingStatus
    Type
    string
    Description

    Filter the transactions by booking status. Available options: booked.

  • Name
    dateFrom
    Type
    string
    Description

    Starting date of the transaction list, mandated if no delta access is required. For booked transactions, the relevant date is the booking date.

  • Name
    dateTo
    Type
    string
    Description

    Ending date of the transaction list, mandated if no delta access is required. For booked transactions, the relevant date is the booking date.

  • Name
    entryReferenceFrom
    Type
    string
    Description

    Start of the range of entry references to be included in the list.

  • Name
    deltaList
    Type
    boolean
    Description

    If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

  • Name
    withBalance
    Type
    boolean
    Description

    If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

  • Name
    ClientId
    Type
    string
    Description

    The PSU's client identifier used by the TPP. It is recommended to use it if provided by the ASPSP during AIS registration.

  • Name
    consentID
    Type
    string
    Description

    The consentId of the related AIS consent, which was performed prior to this payment initiation.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    account
    Type
    object
    Description

    A list of items associated to an account. Each account includes:

    • iban: the IBAN of the account.
    • bban: the Basic Bank Account Number of the account.
    • pan: the Primary Account Number, equivalent to the card number for a card account.
    • maskedPan: the Primary Account Number masked with all but the last 4 characters.
    • msisdn: the Mobile Station Integrated Services Digital Network Number, a phone number associated with the account.
    • currency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
  • Name
    transactions
    Type
    object
    Description

    An array of transaction objects, where each object includes:

    • booked: data related to a booked transaction,including:
    • transactionId: the transaction identifier.
    • entryReference: a reference to identify the transaction.
    • endToEndId: the end-to-end identifier of the transaction.
    • mandateId: the mandate identifier of the transaction.
    • checkId: the check identifier of the transaction.
    • creditorId: the creditor identifier of the transaction.
    • bookingDate: the date the transaction was processed on the bank account.
    • valueDate: the date and time of the transaction.
    • transactionAmount: the amount of the transaction as a string with decimal separator. It includes:
      • currency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
      • Amount: the amount of the transaction as a string with decimal separator.
      • currencyExchange: the currency exchange rate and amount, including:
        • sourceCurrency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
        • exchangeRate: the exchange rate for the transaction.
        • unitCurrency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
        • targetCurrency: the currency type for the exchange rate, following ISO 4217 standard (e.g., USD, EUR).
        • quotationDate: the date the exchange rate was quoted.
        • contractIdentification: the contract identification for the exchange rate.
      • creditorName: the name of the creditor.
      • creditorAccount: the account of the creditor, including:
        • iban: the IBAN of the creditor.
        • bban: the Basic Bank Account Number of the creditor.
        • pan: the Primary Account Number of the creditor.
        • maskedPan: the Primary Account Number masked with all but the last 4 characters.
        • msisdn: the Mobile Station Integrated Services Digital Network Number of the creditor.
        • currency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
      • ultimateCreditor: the ultimate creditor of the transaction.
      • debtorName: the name of the debtor.
      • debtorAccount: the account of the debtor, including:
        • iban: the IBAN of the debtor.
        • bban: the Basic Bank Account Number of the debtor.
        • pan: the Primary Account Number of the debtor.
        • maskedPan: the Primary Account Number masked with all but the last 4 characters.
        • msisdn: the Mobile Station Integrated Services Digital Network Number of the debtor.
        • currency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
      • ultimateDebtor: the ultimate debtor of the transaction.
      • remittanceInformationUnstructured: the unstructured remittance information.
      • remittanceInformationStructured: the structured remittance information.
      • additionalInformation: additional information related to the transaction.
      • purposeCode: the purpose code of the transaction (integer). Available options: 0 -285.
      • bankTransactionCode: the bank transaction code of the transaction.
      • proprietaryBankTransactionCode: the proprietary bank transaction code of the transaction.
      • links: links to related resources or endpoints associated with the transaction.
    • pending: data related to a pending transaction, including:
      • transactionId: the transaction identifier.
      • entryReference: a reference to identify the transaction.
      • endToEndId: the end-to-end identifier of the transaction.
      • mandateId: the mandate identifier of the transaction.
      • checkId: the check identifier of the transaction.
      • creditorId: the creditor identifier of the transaction.
      • bookingDate: the date the transaction was processed on the bank account.
      • valueDate: the date of the transaction.
      • transactionAmount: the amount of the transaction as a string with decimal separator. It includes:
        • currency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
        • Amount: the amount of the transaction as a string with decimal separator.
      • currencyExchange: the currency exchange rate and amount, including:
        • sourceCurrency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
        • exchangeRate: the exchange rate for the transaction.
        • unitCurrency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
        • targetCurrency: the currency type for the exchange rate, following ISO 4217 standard (e.g., USD, EUR).
        • quotationDate: the date the exchange rate was quoted.
        • contractIdentification: the contract identification for the exchange rate.
      • creditorName: the name of the creditor.
      • creditorAccount: the account of the creditor, including:
        • iban: the IBAN of the creditor.
        • bban: the Basic Bank Account Number of the creditor.
        • pan: the Primary Account Number of the creditor.
        • maskedPan: the Primary Account Number masked with all but the last 4 characters.
        • msisdn: the Mobile Station Integrated Services Digital Network Number of the creditor.
        • currency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
      • ultimateCreditor: the ultimate creditor of the transaction.
      • debtorName: the name of the debtor.
      • debtorAccount: the account of the debtor, including:
        • iban: the IBAN of the debtor.
        • bban: the Basic Bank Account Number of the debtor.
        • pan: the Primary Account Number of the debtor.
        • maskedPan: the Primary Account Number masked with all but the last 4 characters.
        • msisdn: the Mobile Station Integrated Services Digital Network Number of the debtor.
        • currency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
      • ultimateDebtor: the ultimate debtor of the transaction.
      • remittanceInformationUnstructured: the unstructured remittance information.
      • remittanceInformationStructured: the structured remittance information.
      • additionalInformation: additional information related to the transaction.
      • purposeCode: the purpose code of the transaction (integer). Available options: 0 -285.
      • bankTransactionCode: the bank transaction code of the transaction.
      • proprietaryBankTransactionCode: the proprietary bank transaction code of the transaction.
      • links: links to related resources or endpoints associated with the transaction.
  • Name
    balances
    Type
    object
    Description

    The balance of the account after the transaction, including:

    • balanceAmount: the amount of funds available for the given balance type.
      • currency: the currency of the balance amount.
      • Amount: the amount of funds available for the given balance type.
    • balanceType: the type of the balance, i.e. booked or available.
    • creditLimitIncluded: indicates whether the credit limit is included in the balance.
    • lastChangeDateTime: the date and time of the last change made to the account details.
    • referenceDate: the date for which the account information is retrieved.
    • lastCommittedTransaction: information about the last committed transaction on the account.
  • Name
    links
    Type
    object
    Description

    Links to related resources or endpoints associated with the balance.

  • Name
    links
    Type
    object
    Description

    Links to related resources or endpoints associated with the transaction.

  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the transaction information.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent, including:

    • items: the list of items associated with the consent.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the response. Available options: 0 -285.

  • Name
    tppMessages
    Type
    string
    Description

    The list of TPP messages associated with the consent, including:

    • category: the category of the message.
    • code: the code of the message.
    • path: the path of the message.
    • text: the text of the message.

Request

GET
/v1/accounts/{account-id}/transactions?bookingStatus=string
curl -X GET /v1/accounts/{account-id}/transactions?bookingStatus=string \
-H 'Accept: application/json' \
-H 'x-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'consentID: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"account": {
"iban": "",
"bban": "",
"pan": "",
"maskedPan": "",
"msisdn": "",
"currency": ""
},
"transactions": {
"booked": [
  {
    "transactionId": "",
    "entryReference": "",
    "endToEndId": "",
    "mandateId": "",
    "checkId": "",
    "creditorId": "",
    "bookingDate": "",
    "valueDate": "",
    "transactionAmount": {
      "currency": "",
      "Amount": ""
    },
    "currencyExchange": [
      {
        "sourceCurrency": "",
        "exchangeRate": "",
        "unitCurrency": "",
        "targetCurrency": "",
        "quotationDate": "",
        "contractIdentification": ""
      }
    ],
    "creditorName": "",
    "creditorAccount": {
      "iban": "",
      "bban": "",
      "pan": "",
      "maskedPan": "",
      "msisdn": "",
      "currency": ""
    },
    "ultimateCreditor": "",
    "debtorName": "",
    "debtorAccount": {
      "iban": "",
      "bban": "",
      "pan": "",
      "maskedPan": "",
      "msisdn": "",
      "currency": ""
    },
    "ultimateDebtor": "",
    "remittanceInformationUnstructured": "",
    "remittanceInformationStructured": "",
    "additionalInformation": "",
    "purposeCode": 0,
    "bankTransactionCode": "",
    "proprietaryBankTransactionCode": "",
    "links": ""
  }
],
"pending": [
  {
    "transactionId": "",
    "entryReference": "",
    "endToEndId": "",
    "mandateId": "",
    "checkId": "",
    "creditorId": "",
    "bookingDate": "",
    "valueDate": "",
    "transactionAmount": {
      "currency": "",
      "Amount": ""
    },
    "currencyExchange": [
      {
        "sourceCurrency": "",
        "exchangeRate": "",
        "unitCurrency": "",
        "targetCurrency": "",
        "quotationDate": "",
        "contractIdentification": ""
      }
    ],
    "creditorName": "",
    "creditorAccount": {
      "iban": "",
      "bban": "",
      "pan": "",
      "maskedPan": "",
      "msisdn": "",
      "currency": ""
    },
    "ultimateCreditor": "",
    "debtorName": "",
    "debtorAccount": {
      "iban": "",
      "bban": "",
      "pan": "",
      "maskedPan": "",
      "msisdn": "",
      "currency": ""
    },
    "ultimateDebtor": "",
    "remittanceInformationUnstructured": "",
    "remittanceInformationStructured": "",
    "additionalInformation": "",
    "purposeCode": 0,
    "bankTransactionCode": "",
    "proprietaryBankTransactionCode": "",
    "links": ""
  }
],
"links": ""
},
"balances": [
{
  "balanceAmount": {
    "currency": "",
    "Amount": ""
  },
  "balanceType": 0,
  "creditLimitIncluded": false,
  "lastChangeDateTime": "",
  "referenceDate": "",
  "lastCommittedTransaction": ""
}
],
"links": ""
}

Responses

StatusDescription
200OK
400Bad Request
401Unauthorised
403Forbidden
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests
GET/v1/accounts/{account-id}/transactions/{transactionId}

Fetch transaction details

Retrieve specific information about a transaction (transaction amount, currency exchange details, creditor / debtor info) on a given account addressed by account-id.

Gain insights into individual transactions within an account.

Path parameters

  • Name
    account-id
    Type
    string
    Description

    The account-id is retrieved by the Fetch accounts list call and is constant at least throughout the lifecycle of a given consent.

  • Name
    transactionId
    Type
    string
    Description

    ID of the transaction that needs to be retrieved.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

  • Name
    ClientId
    Type
    string
    Description

    ID of the PSU in the ASPSP client interface. Might be mandated in the ASPSP system. Unique within the ASPSP system.

  • Name
    consentID
    Type
    string
    Description

    The consentId of the related AIS consent, which was performed prior to this payment initiation.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    transactionId
    Type
    string
    Description

    The unique identifier of the transaction.

  • Name
    entryReference
    Type
    string
    Description

    A reference to identify the transaction.

  • Name
    endToEndId
    Type
    string
    Description

    The end-to-end identifier of the transaction.

  • Name
    mandateId
    Type
    string
    Description

    The mandate identifier of the transaction.

  • Name
    checkId
    Type
    string
    Description

    The check identifier of the transaction.

  • Name
    creditorId
    Type
    string
    Description

    The creditor identifier of the transaction.

  • Name
    bookingDate
    Type
    string
    Description

    The date the transaction was processed on the bank account.

  • Name
    valueDate
    Type
    string
    Description

    The date the funds left/were received in the account.

  • Name
    transactionAmount
    Type
    object
    Description

    The amount of the transaction as a string with decimal separator.

    • currency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
    • Amount: the amount of the transaction as a string with decimal separator.
  • Name
    currencyExchange
    Type
    array
    Description

    The currency exchange rate and amount.

    • sourceCurrency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
    • exchangeRate: the exchange rate for the transaction.
    • unitCurrency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
    • targetCurrency: the currency type for the exchange rate, following ISO 4217 standard (e.g., USD, EUR).
    • quotationDate: the date the exchange rate was quoted.
    • contractIdentification: the contract identification for the exchange rate.
  • Name
    creditorName
    Type
    string
    Description

    The name of the creditor.

  • Name
    creditorAccount
    Type
    object
    Description

    The account of the creditor, including:

    • iban: the IBAN of the creditor.
    • bban: the Basic Bank Account Number of the creditor.
    • pan: the Primary Account Number of the creditor.
    • maskedPan: the Primary Account Number masked with all but the last 4 characters.
    • msisdn: the Mobile Station Integrated Services Digital Network Number of the creditor.
    • currency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
  • Name
    ultimateCreditor
    Type
    string
    Description

    The ultimate creditor of the transaction.

  • Name
    debtorName
    Type
    string
    Description

    The name of the debtor.

  • Name
    debtorAccount
    Type
    object
    Description

    The account of the debtor, including:

    • iban: the IBAN of the debtor.
    • bban: the Basic Bank Account Number of the debtor.
    • pan: the Primary Account Number of the debtor.
    • maskedPan: the Primary Account Number masked with all but the last 4 characters.
    • msisdn: the Mobile Station Integrated Services Digital Network Number of the debtor.
    • currency: the currency type for the transaction, following ISO 4217 standard (e.g., USD, EUR).
  • Name
    ultimateDebtor
    Type
    string
    Description

    The ultimate debtor of the transaction.

  • Name
    remittanceInformationUnstructured
    Type
    string
    Description

    The unstructured remittance information.

  • Name
    remittanceInformationStructured
    Type
    string
    Description

    The structured remittance information.

  • Name
    additionalInformation
    Type
    string
    Description

    Additional information about the transaction.

  • Name
    purposeCode
    Type
    integer
    Description

    The purpose code of the transaction. Available options: 0 - 285.

  • Name
    bankTransactionCode
    Type
    string
    Description

    The bank transaction code of the transaction.

  • Name
    proprietaryBankTransactionCode
    Type
    string
    Description

    The proprietary bank transaction code of the transaction.

  • Name
    links
    Type
    object
    Description

    Links of information related to the booked transaction.

  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the consent information.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent. It includes:

    • items (object): The list of items related to the consent information.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the consent.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
/v1/accounts/{account-id}/transactions/{transactionId}
curl -X GET /v1/accounts/{account-id}/transactions/{transactionId} \
-H 'Accept: application/json' \
-H 'x-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'consentID: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"transactionId": "",
"entryReference": "",
"endToEndId": "",
"mandateId": "",
"checkId": "",
"creditorId": "",
"bookingDate": "",
"valueDate": "",
"transactionAmount": {
"currency": "",
"Amount": ""
},
"currencyExchange": [
{
  "sourceCurrency": "",
  "exchangeRate": "",
  "unitCurrency": "",
  "targetCurrency": "",
  "quotationDate": "",
  "contractIdentification": ""
}
],
"creditorName": "",
"creditorAccount": {
"iban": "",
"bban": "",
"pan": "",
"maskedPan": "",
"msisdn": "",
"currency": ""
},
"ultimateCreditor": "",
"debtorName": "",
"debtorAccount": {
"iban": "",
"bban": "",
"pan": "",
"maskedPan": "",
"msisdn": "",
"currency": ""
},
"ultimateDebtor": "",
"remittanceInformationUnstructured": "",
"remittanceInformationStructured": "",
"additionalInformation": "",
"purposeCode": 0,
"bankTransactionCode": "",
"proprietaryBankTransactionCode": "",
"links": ""
}

Responses

StatusDescription
200OK
400Bad Request
401Unauthorised
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests
POST/v1/consents

Create a consent that defines access rights to dedicated accounts.

This is the first step in the process where the Third-Party Provider (TPP) requests access to a user account.

Create a new consent request and automatically expire any existing consent for recurring access on account information for the addressed PSU.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The TPP's public certificate in base64 encoding.

  • Name
    ClientId
    Type
    string
    Description

    The TPP's client ID.

  • Name
    PSU_ID
    Type
    string
    Description

    The PSU's ID, as determined by the PSU. This ID is the identification of the PSU within the ASPSP and should contain the web user's username that requests the consent or initiates the payment.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Body parameters

  • Name
    access
    Type
    object
    Description

    The access information granted with the consent, including:

    • accounts (array): The accounts linked to the consent. It includes:
      • iban (string): The International Bank Account Number (IBAN) provided in the request body.
      • bban (string): The Basic Bank Account Number (BBAN) provided in the request body.
      • pan (string): The Primary Bank Account Number (PAN) provided in the request body.
      • maskedPan (string): The masked PAN provided in the request body.
      • msisdn (string): The Mobile Subscriber Integrated Services Digital Network (MSISDN) provided in the request body.
      • currency (string): The currency of the account.
  • Name
    balances
    Type
    array
    Description

    The balances of the accounts that the consent is granted for. It includes:

    • iban (string): The International Bank Account Number (IBAN) of the account.
    • bban (string): The Basic Bank Account Number (BBAN) of the account.
    • pan (string): The Primary Account Number (PAN) of the account.
    • maskedPan (string): The masked Primary Account Number of the account.
    • msisdn (string): The Mobile Station International Subscriber Directory Number of the account.
    • currency (string): The currency of the account.
  • Name
    transactions
    Type
    array
    Description

    The transactions associated with the consent. It includes:

    • iban (string): The International Bank Account Number (IBAN) associated with the consent.
    • bban (string): The Basic Bank Account Number(BBAN) associated with the consent.
    • pan (string): The Primary Account Number (PAN) associated with the consent.
    • maskedPan (string): The masked Primary Account Number associated with the consent.
    • msisdn (string): The Mobile Station International Subscriber Directory Number associated with the consent.
    • currency (string): The currency in which the consent is created.
  • Name
    availableAccounts
    Type
    string
    Description

    Indicates if the consent is for all available accounts. (optional)
    Available options: allAccounts (when used the accounts, balances and transactions are empty)

  • Name
    availableAccountsWithBalance
    Type
    string
    Description

    Indicates if the consent is for all available accounts with balances. (optional)
    Available options: allAccounts (when used the accounts, balances and transactions are empty)

  • Name
    allPsd2
    Type
    string
    Description

    Indicates if the consent is for all Payment Services Directive 2 (PSD2) services. (optional)
    Available options: allAccounts (when used the accounts, balances and transactions are empty)

  • Name
    recurringIndicator
    Type
    boolean
    Description

    Indicator specifying whether the consent is for recurring payments.

  • Name
    validUntil
    Type
    date-time
    Description

    The date and time until the consent is valid.

  • Name
    frequencyPerDay
    Type
    integer
    Description

    The maximum frequency of payments per day allowed by the consent.

  • Name
    combinedServiceIndicator
    Type
    boolean
    Description

    Indicator specifying whether a combined service is requested.

Response attributes

  • Name
    consentStatus
    Type
    string
    Description

    The status of the consent.
    Available options: 0 (received), 1(rejected), 2(valid), 3(revokedByPsu), 4(expired) or 5(terminatedByTpp).

  • Name
    consentId
    Type
    string
    Description

    The consent ID. It is a unique identifier for the consent.

  • Name
    scaMethods
    Type
    string
    Description

    The list of available SCA methods. It includes:

    • authenticationType (string): The authentication method type.
    • authenticationVersion (string): The authentication method version.
    • authenticationMethodId (string): The authentication method ID.
    • name (string): The authentication method name.
    • explanation (string): The authentication method description.
  • Name
    chosenScaMethod
    Type
    string
    Description

    The chosen SCA method. It includes:

    • authenticationType (string): The authentication method type.
    • authenticationVersion (string): The authentication method version.
    • authenticationMethodId (string): The authentication method ID.
    • name (string): The authentication method name.
    • explanation (string): The authentication method description.
  • Name
    challengeData
    Type
    array
    Description

    The challenge data. It includes:

    • image (string): The challenge image.
    • data (string): The challenge data.
  • Name
    imageLink
    Type
    string
    Description

    The link to the challenge image.

  • Name
    otpMaxLength
    Type
    integer
    Description

    The maximum length of the OTP.

  • Name
    otpFormat
    Type
    integer
    Description

    The format of the OTP.

  • Name
    links
    Type
    object
    Description

    Links associated with the response.

  • Name
    message
    Type
    string
    Description

    The message related to the consent.

  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the consent information.

  • Name
    links
    Type
    object
    Description

    The links associated with the error.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent, including:

    • items (object): The list of items related to the consent information.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the consent.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.

Request

POST
/v1/consents
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'PSU_ID: string' \
-H 'Ocp-Apim-Subscription-Key: string' \
-d '{"access":{"accounts":[{"bban":"string","currency":"string","iban":"string","maskedPan":"string","msisdn":"string","pan":"string"}],"allPsd2":"string","availableAccounts":"string","availableAccountsWithBalance":"string","balances":[{"bban":"string","currency":"string","iban":"string","maskedPan":"string","msisdn":"string","pan":"string"}],"transactions":[{"bban":"string","currency":"string","iban":"string","maskedPan":"string","msisdn":"string","pan":"string"}]},"combinedServiceIndicator":true,"frequencyPerDay":42,"recurringIndicator":true,"validUntil":"2024-05-04"}'

Response examples

{
"consentStatus": 0,
"consentId": "",
"scaMethods": [
{
  "authenticationType": 0,
  "authenticationVersion": "",
  "authenticationMethodId": "",
  "name": "",
  "explanation": ""
}
],
"chosenScaMethod": {
"authenticationType": 0,
"authenticationVersion": "",
"authenticationMethodId": "",
"name": "",
"explanation": ""
},
"challengeData": {
"image": "",
"data": [
  ""
],
"imageLink": "",
"otpMaxLength": "",
"otpFormat": 0,
"additionalInformation": ""
},
"links": "",
"message": ""
}

Responses

StatusDescription
201Created
400Bad Request
401Unauthorised
403Forbidden
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests
DELETE/v1/consents/{consentId}

Revoke a consent for certain actions within the PSD2 framework. You can securely remove consent permissions associated with a specific consent, ultimately providing greater control over data access and usage.

This step should be used with caution. Once a consent is revoked, the TPP (Third-Party Provider) will no longer have access to the data associated with the consent.

Path parameters

  • Name
    consentId
    Type
    string
    Description

    The ID of the consent as returned by the consent request.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate used for signing the request, in base64 encoding.

  • Name
    ClientId
    Type
    string
    Description

    The TPP's client ID.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response atrributes

  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the consent information.

  • Name
    statusCode
    Type
    integer
    Description

    The status code of the response.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent. It includes:

    • items (object): The list of items related to the consent information.
  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

DELETE
/v1/consents/{consentId}
curl -X DELETE /v1/consents/{consentId} \
-H 'Accept: application/json' \
-H 'x-Request-ID: string' \
-H 'Certificate: string' \ 
-H 'ClientId: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"tppMessages": [
{
  "category": 0,
  "code": 0,
  "path": "",
  "text": ""
}
],
"links": ""
}

Responses

StatusDescription
400Bad Request
401Unauthorised
403Forbidden
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests
GET/v1/consents/{consentId}

Retrieve detailed information about a specific consent.

Access account details, balances and transactions authorised by a specific consent.

Path parameters

  • Name
    consentId
    Type
    string
    Description

    The ID of the consent as returned by the request.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate used for signature verification.

  • Name
    ClientId
    Type
    string
    Description

    The client ID associated with the request.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    access
    Type
    object
    Description

    The access information granted with the consent, including:

    • accounts (array): The accounts linked to the consent. It includes:
      • iban (string): The International Bank Account Number (IBAN) of the account.
      • bban (string): The Basic Bank Account Number (BBAN) of the account.
      • pan (string): The Primary Bank Account Number (PAN) of the account.
      • maskedPan (string): The masked PAN of the account.
      • msisdn (string): The MSISDN of the account.
      • currency (string): The currency of the account.
  • Name
    balances
    Type
    array
    Description

    The balances of the accounts that the consent is granted for. It includes:

    • iban (string): The International Bank Account Number (IBAN) of the account.
    • bban (string): The Basic Bank Account Number (BBAN) of the account.
    • pan (string): The Primary Account Number (PAN) of the account.
    • currency (string): The currency in which the consent is created.
    • maskedPan (string): The masked Primary Account Number of the account.
    • msisdn (string): The Mobile Station International Subscriber Directory Number of the account.
  • Name
    transactions
    Type
    array
    Description

    The transactions associated with the consent. It includes:

    • iban (string): The International Bank Account Number (IBAN) associated with the consent.
    • bban (string): The Basic Bank Account Number(BBAN) associated with the consent.
    • pan (string): The Primary Account Number (PAN) associated with the consent.
    • maskedPan (string): The masked Primary Account Number associated with the consent.
    • msisdn (string): The Mobile Station International Subscriber Directory Number associated with the consent.
    • currency (string): The currency in which the consent is created.
  • Name
    availableAccounts
    Type
    string
    Description

    The list of accounts that the consent is granted for. (optional)
    Available options: allAcounts (when used the accounts, balances and transactions are empty)

  • Name
    availableAccountswithBalance
    Type
    string
    Description

    The list of accounts that the consent is granted for. (optional)
    Available options: allAccounts (when used the accounts, balances and transactions are empty)

  • Name
    allPsd2
    Type
    string
    Description

    Indicates if the consent is for all Payment Services Directive 2 (PSD2) services. (optional)
    Available options: allAccounts (when used the accounts, balances and transactions are empty)

  • Name
    recurringIndicator
    Type
    boolean
    Description

    Indicator specifying whether the consent is for recurring payments.

  • Name
    validUntil
    Type
    date-time
    Description

    The date and time until the consent is valid.

  • Name
    frequencyPerDay
    Type
    integer
    Description

    The maximum frequency of payments per day allowed by the consent.

  • Name
    lastActionDate
    Type
    date-time
    Description

    The date of the last action performed.

  • Name
    consentStatus
    Type
    boolean
    Description

    The status of the consent. Available options:

    • 0 - The consent is received.
    • 1 - The consent is rejected.
    • 2 - The consent is valid.
    • 3 - The consent is revoked by the PSU.
    • 4 - The consent is expired.
    • 5 - The consent is terminated by TPP.
  • Name
    links
    Type
    object
    Description

    Links associated with the response.

  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the consent information.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent, including:

    • items (array): The list of items related to the consent information.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the response.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
/v1/consents/{consentId}
curl -X GET /v1/consents/{consentId} \
-H 'Accept: application/json' \
-H 'x-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"access": {
"accounts": [
  {
    "iban": "",
    "bban": "",
    "pan": "",
    "maskedPan": "",
    "msisdn": "",
    "currency": ""
  }
],
"balances": [
  {
    "iban": "",
    "bban": "",
    "pan": "",
    "maskedPan": "",
    "msisdn": "",
    "currency": ""
  }
],
"transactions": [
  {
    "iban": "",
    "bban": "",
    "pan": "",
    "maskedPan": "",
    "msisdn": "",
    "currency": ""
  }
],
"availableAccounts": "",
"availableAccountsWithBalance": "",
"allPsd2": ""
},
"recurringIndicator": false,
"validUntil": "",
"frequencyPerDay": "",
"lastActionDate": "",
"consentStatus": 0,
"links": ""
}

Responses

StatusDescription
200Created
400Bad Request
401Unauthorised
403Forbidden
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests
GET/v1/consents/{consentId}/authorisations

Initiate the authorisation process for a specific consent.

Trigger the authentication flow and select the appropriate authentication method.

It is essential for managing the security and authentication requirements within the PSD2 framework.

Path parameters

  • Name
    consentId
    Type
    string
    Description

    The ID of the consent as returned by the request.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate used for signing the request, in base64 encoding.

  • Name
    ClientId
    Type
    string
    Description

    The ID of the client, as assigned by the PSU, if the PSU is a PSU-registered user.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    authorisationIds
    Type
    string
    Description

    The authorization IDs associated with the request.

  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the consent information.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent, including:

    • items (array): The list of items related to the consent information.
  • Name
    statusCode
    Type
    integer
    Description

    The status of the consent. Possible values:

    • 0 : received
    • 1 : rejected
    • 2 : valid
    • 3 : revoked by PSU
    • 4 : expired
    • 5 : terminated by TPP
  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
/v1/consents/{consentId}/authorisations
curl -X GET /v1/consents/{consentId}/authorisations \
-H 'Accept: application/json' \
-H 'X-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"authorisationIds": [
""
]
}

Responses

StatusDescription
201Created
400Bad Request
401Unauthorised
403Forbidden
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests
POST/v1/consents/{consentId}/authorisations

Initiate the authorisation process for a specific consent.

Trigger the authentication flow and select the appropriate authentication method.

It is essential for managing the security and authentication requirements within the PSD2 framework.

Path parameters

  • Name
    consentId
    Type
    string
    Description

    The ID of the consent as returned by the request.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate used for signing the request, in base64 encoding.

  • Name
    ClientId
    Type
    string
    Description

    The ID of the client, as assigned by the PSU, if the PSU is a PSU-registered user.

  • Name
    PSU_ID
    Type
    string
    Description

    The PSU's ID, as determined by the PSU. This ID is the identification of the PSU within the ASPSP and should contain the web user's username that requests the consent or initiates the payment.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    scaStatus
    Type
    string
    Description

    The status of the SCA method. The consentStatus parameter represents the status of the consent. It indicates whether the consent is active, revoked, expired, or otherwise.

  • Name
    authorisationId
    Type
    string
    Description

    The ID of the authorisation.

  • Name
    scaMethods
    Type
    array
    Description

    The methods available for the PSU to authorise the consent.

    • authenticationType - The authentication type.
    • authenticationVersion - The authentication version.
    • authenticationMethodId - It represents the ID of the authentication method used for the consent authorisation.
    • name - It represents the name associated with the consent.
    • explanation - It provides an explanation for the consent authorisation.
  • Name
    chosenScaMethod
    Type
    object
    Description

    It represents the selected SCA (Strong Customer Authentication) method for the consent authorisation. It includes:

    • authenticationType - The authentication type. (integer)
    • authenticationVersion - The authentication version.
    • authenticationMethodId - It represents the ID of the authentication method used for the consent authorisation.
    • name - It represents the name associated with the consent.
    • explanation - It provides an explanation for the consent authorisation
  • Name
    challengeData
    Type
    Description

    It contains the challenge data for the consent authorisation, including:

    • image: The image associated with the consent authorisation.
    • data: The data associated with the consent authorisation.
    • imageLink: The link to the image associated with the consent authorisation.
    • otpMaxLength: The maximum length of the OTP associated with the consent authorisation.
    • otpFormat: The OTP format associated with the consent authorisation.
    • additionalInformation: Additional information associated with the consent authorisation.
  • Name
    links
    Type
    object
    Description

    It contains links related to the consent authorisation.

  • Name
    psuMessage
    Type
    string
    Description

    It contains the message for the PSU (Payer Service User).

  • Name
    links
    Type
    object
    Description

    Links associated with the error.

  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the consent information.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent, including:

    • items - The list of items associated with the consent.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the response.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

POST
/v1/consents/{consentId}/authorisations
curl -X POST /v1/consents/{consentId}/authorisations \
-H 'Accept: application/json' \
-H 'X-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'PSU_ID: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"scaStatus": "",
"authorisationId": "",
"scaMethods": [
{
  "authenticationType": 0,
  "authenticationVersion": "",
  "authenticationMethodId": "",
  "name": "",
  "explanation": ""
}
],
"chosenScaMethod": {
"authenticationType": 0,
"authenticationVersion": "",
"authenticationMethodId": "",
"name": "",
"explanation": ""
},
"challengeData": {
"image": "",
"data": [
  ""
],
"imageLink": "",
"otpMaxLength": "",
"otpFormat": 0,
"additionalInformation": ""
},
"links": "",
"psuMessage": ""
}

Responses

StatusDescription
201Created
400Bad Request
401Unauthorised
403Forbidden
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests
GET/v1/consents/{consentId}/authorisations/{authorisationId}

Retrieve the Strong Customer Authentication (SCA) status of the authorisation for a consent initiation. Check whether SCA has been completed for a specific authorisation and make decisions based on the authentication status.

Use this information to determine the current status of the authorisation process for a specific consent.

Path parameters

  • Name
    consentId
    Type
    string
    Description

    The unique identifier of the consent for which authorisation information is being requested.

  • Name
    authorisationId
    Type
    string
    Description

    The unique identifier of the authorisation associated with the consent.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    The certificate used for signing the request, in base64 encoding.

  • Name
    ClientId
    Type
    string
    Description

    The ID of the client, as assigned by the PSU, if the PSU is a PSU-registered user.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    scaStatus
    Type
    integer
    Description

    Indicates the Strong Customer Authentication (SCA) status. Available options:

    • 0 - received.
    • 1 - psuIdentified
    • 2 - psuAuthenticated
    • 3 - scaMethodSelected
    • 4 - started
    • 5 - finalised
    • 6 - failed
    • 7 - exempted
  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the consent information.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent, including:

    • items: The list of items associated with the consent.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the response.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
v1/consents/{consentId}/authorisations/{authorisationId}
curl -X GET /v1/consents/{consentId}/authorisations/{authorisationId} \
-H 'Accept: application/json' \
-H 'x-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"scaStatus": 0
}

Responses

StatusDescription
200Created
400Bad Request
401Unauthorised
403Forbidden
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests
GET/v1/consents/{consentId}/status

Retrieve the status of a consent. Check the current status of a consent and determine if it is active, expired, revoked or in any other state.

Path parameters

  • Name
    consentId
    Type
    string
    Description

    The ID of the consent as returned by the consent request.

Headers

  • Name
    x-Request-ID
    Type
    string(uuid)
    Description

    ID of the request, unique to the call, as determined by the initiating party.

  • Name
    Certificate
    Type
    string
    Description

    Is contained if and only if the Signature element is contained in the header of the request.

  • Name
    ClientId
    Type
    string
    Description

    The unique identifier of the PSU, unique between the PSU and the TPP.

  • Name
    Ocp-Apim-Subscription-Key
    Type
    string
    Description

    A unique identifier related to the registered merchant in the snappi API environment, available within the application's details.

Response attributes

  • Name
    consentStatus
    Type
    string
    Description

    The status of the consent. Valid values: received | valid | rejected | expired | terminatedByTpp

  • Name
    authenticationSchemes
    Type
    array(string)
    Description

    The list of authentication methods used for the consent information.

  • Name
    properties
    Type
    string
    Description

    The list of various properties associated with the consent, including:

    • items: The list of items associated with the consent.
  • Name
    statusCode
    Type
    integer
    Description

    The status code of the response.

  • Name
    tppMessages
    Type
    object
    Description

    The list of messages returned from the ASPSP. It includes:

    • category (integer): The message category of the error. Available options: 0, 1.
    • code (integer): The code of the error.
    • path (string): The path associated with the error.
    • text (string): The text associated with the error.
  • Name
    links
    Type
    object
    Description

    Links associated with the error.

Request

GET
/v1/consents/{consentId}/status
curl -X GET /v1/consents/{consentId}/status \
-H 'Accept: application/json' \
-H 'x-Request-ID: string' \
-H 'Certificate: string' \
-H 'ClientId: string' \
-H 'Ocp-Apim-Subscription-Key: string'

Response examples

{
"consentStatus": ""
}

Responses

StatusDescription
200Created
400Bad Request
401Unauthorised
403Forbidden
404Not Found
405Method Not Allowed
406Not Acceptable
409Conflict
429Too Many Requests