Accounts
The Accounts API gives you access to details, transactions and balances for accounts, all within the scope of a granted consent.
You can generate transaction reports for a specific account, allowing you to easily track and analyze transactions. You can also retrieve the balances of a given account, providing real-time information on the available funds.
Press each of the following tabs and examine the process flows:
- for account information access using our API in compliance with PSD2
- with authentication and consent handled entirely by the Snappi mobile application
Each process involves several stages, including user authentication, consent creation, authorization and verification.
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 (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
Response attributes
- 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
- 0 =
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. If null or empty, consider that reference datetime is equivalent with the datetime that the API call has been made.lastCommittedTransaction: Information about the last committed transaction on the account.
- Name
links- Type
- object
- Description
The
linksparameter 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
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
| Status | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
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 (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
Response attributes
- 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
- 0 =
- 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: The date for which the account information is retrieved. If null or empty, consider that reference datetime is equivalent with the datetime that the API call has been made.lastCommittedTransaction: The last committed transaction associated with the account.
- Name
links- Type
- object
- Description
The
linksparameter 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
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
| Status | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
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-idis 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 signature verification (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
Response attributes
- 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. If null or empty, consider that reference datetime is equivalent with the datetime that the API call has been made.lastCommittedTransaction: Information about the last committed transaction on the account.
- Name
links- Type
- object
- Description
The
linksparameter 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
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
| Status | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
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-idis 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
Indicates the progress of a reservation and its payment. Available options: booked
A booked transaction status means that the booking has been successfully created, but may still be pending final confirmation, payment or processing.
- 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
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 signature verification (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
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. If null or empty, consider that reference datetime is equivalent with the datetime that the API call has been made.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
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
| Status | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
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.
Path parameters
- Name
account-id- Type
- string
- Description
The
account-idis 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 signature verification (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
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
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
| Status | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
Fetch cards list
Retrieve the list of cards associated with the user’s account, including detailed information such as card identifiers, account status and balances.
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 (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
Response attributes
- Name
cards- Type
- object
- Description
Contains account information related to the cards of the user. Each array includes:
resourceId(string): The resource identifier for the card resource within the system.maskedPan(string): The card number partially masked for security, typically showing only the last four digits.currency(string): The three-letter ISO currency code for all monetary amounts related to the card.name(string): The name assigned to the card, often reflecting the cardholder’s name or card nickname.product(string): The card product type or category, such as credit, debit, or prepaid.status(string): The current state of the card. Available options:enabled: The card is fully operational and can be used normally for payments, ATM withdrawals and digital transactions.deleted: The card has been permanently disabled and cannot be used again. Typically replaced by a newer card.blocked: The card is temporarily blocked (e.g., due to suspected fraud, PSD2 SCA lockout or customer request). It may be unblocked later.
details(string): Additional card-specific information, including issuance data and cardholder details.creditLimit(object): The maximum credit amount available on the card, including:currency(string): The three-letter ISO currency code corresponding to the amounts (e.g., USD, EUR).Amount(string): The monetary value associated with the card transaction or balance, represented in the smallest currency unit.
balances(object): Various balance types associated with the card, such as available or pending amounts, each including:balanceAmount(string): The card’s current balance in the specified currency. It includes:currency(string): The three-letter ISO currency code for all monetary amounts related to the card.Amount(string): The numeric value representing a monetary amount, typically related to balances or limits.
balanceType(integer): The type of the balance. Available values:- 0 =
closingBooked - 1 =
expected - 2 =
authorised - 3 =
openingBooked - 4 =
interimAvailable - 5 =
interimBooked - 6 =
forwardAvailable - 7 =
nonInvoiced
- 0 =
creditLimitIncluded(boolean): Indicates whether the credit limit is included in the card's balance calculations.lastChangeDateTime(date-time): Timestamp of the last modification made to the card’s information, in ISO 8601 format.referenceDate(date-time): The date associated with the card's current status or balance snapshot, formatted asYYYY-MM-DD. If null or empty, consider that reference datetime is equivalent with the datetime that the API call has been made.lastCommittedTransaction(string): Details of the most recent transaction that has been finalized on the card.
- Name
links- Type
- object
- Description
Collection of URLs related to the card resource, enabling navigation to related endpoints.
- Name
authenticationSchemes- Type
- array(string)
- Description
The list of authentication methods used for the consent information.
- Name
properties- Type
- object
- 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
- 0 =
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
curl -X GET /v1/cards \
-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
{
"cards": [
{
"resourceId": "",
"maskedPan": "",
"currency": "",
"name": "",
"product": "",
"status": "",
"details": "",
"creditLimit": {
"currency": "",
"Amount": ""
},
"balances": [
{
"balanceAmount": {
"currency": "",
"Amount": ""
},
"balanceType": 0,
"creditLimitIncluded": false,
"lastChangeDateTime": "",
"referenceDate": "",
"lastCommittedTransaction": ""
}
],
"links": {}
}
]
}
Responses
| Status | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
Fetch card details
Retrieve detailed information about a specific card, including its status, associated product, currency, credit limits and balance details.
Path parameters
- Name
card-id- Type
- string
- Description
The unique identifier of the card to retrieve details for.
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 (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
Response attributes
- Name
resourceId- Type
- string
- Description
Unique identifier for the resource associated with the card.
- Name
maskedPan- Type
- string
- Description
The card number masked for security, typically showing only the last four digits.
- Name
currency- Type
- string
- Description
The ISO 4217 currency code representing the currency of amounts associated with the card.
- Name
name- Type
- string
- Description
The name associated with the card or the cardholder.
- Name
product- Type
- string
- Description
The card product type or plan associated with the card, such as credit or debit.
- Name
status- Type
- string
- Description
The current state of the card. Available options:
enabled: The card is fully operational and can be used normally for payments, ATM withdrawals and digital transactions.deleted: The card has been permanently disabled and cannot be used again. Typically replaced by a newer card.blocked: The card is temporarily blocked (e.g., due to suspected fraud, PSD2 SCA lockout or customer request). It may be unblocked later.
- Name
details- Type
- string
- Description
Additional descriptive information about the card, such as issuer or product features.
- Name
creditLimit- Type
- object
- Description
The maximum credit amount allocated to the cardholder, each containing:
currency(string): The ISO 4217 currency code representing the currency of amounts associated with the card.Amount(string): The value of a financial transaction or balance amount in the specified currency.
- Name
balances- Type
- array
- Description
A collection of balance objects associated with the card, each containing:
balanceAmount(object): The amount of balance associated with the card. It includes:currency(string): The ISO 4217 currency code representing the currency of amounts associated with the card.Amount(string): The value of a financial transaction or balance amount in the specified currency.
balanceType(integer): The type of the balance associated with the card. Available options:- 0 -
closingBooked - 1 -
expected - 2 -
authorised - 3 -
openingBooked - 4 -
interimAvailable - 5 -
interimBooked - 6 -
forwardAvailable - 7 -
nonInvoiced
- 0 -
creditLimitIncluded(boolean): Indicates whether the credit limit is included in the balance calculations; true if included, false otherwise.lastChangeDateTime(date-time): Timestamp of the most recent update to the card information in ISO 8601 format.referenceDate(date-time): The date to which the card information or balances are referenced, formatted as YYYY-MM-DD.lastCommittedTransaction(string): Details of the most recent transaction that has been finalized for the card.
- Name
links- Type
- object
- Description
Hypermedia links related to the card resource, enabling navigation to related endpoints.
- Name
authenticationSchemes- Type
- array(string)
- Description
The list of supported authentication methods required to access or authorize the request for card details.
- Name
properties- Type
- string
- Description
Holds additional metadata or attributes related to the card or response, structured as key-value pairs. It includes:
items(object): An array of elements, typically representing multiple entries or detailed objects associated with the card response.
- Name
statusCode- Type
- integer
- Description
The status code of the response.
- Name
tppMessages- Type
- object
- Description
Messages or notifications from the Third-Party Provider (TPP), including warnings or errors, including:
category(integer): The message category of the error. Available options:- 0 =
ERROR - 1 =
WARNING
- 0 =
code(integer): The detailed error or warning code.path(string): The JSON pointer or API path indicating the location related to the message or error.text(string): A text message providing additional context or information related to the status or error code.
- Name
links- Type
- object
- Description
Contains related resource URLs to navigate or reference additional information associated with the card details.
Request
curl -X GET /v1/cards/{card-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
{
"resourceId": "",
"maskedPan": "",
"currency": "",
"name": "",
"product": "",
"status": "",
"details": "",
"creditLimit": {
"currency": "",
"Amount": ""
},
"balances": [
{
"balanceAmount": {
"currency": "",
"Amount": ""
},
"balanceType": 0,
"creditLimitIncluded": false,
"lastChangeDateTime": "",
"referenceDate": "",
"lastCommittedTransaction": ""
}
],
"links": {}
}
Responses
| Status | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
Fetch card transactions
Retrieve a list of transactions associated with a specific card, including both booked and pending entries.
Review detailed transaction data, filter by date range and booking status, and gain insights into card activity and balances.
Path parameters
- Name
card-id- Type
- string
- Description
The unique identifier of the card whose transactions are being requested.
Query parameters
- Name
dateFrom- Type
- date-time
- 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
- date-time
- 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
bookingStatus- Type
- string
- Description
Indicates the progress of a reservation and its payment. Available options: booked
A booked transaction status means that the booking has been successfully created, but may still be pending final confirmation, payment or processing.
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 (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
Response attributes
- Name
card-account- Type
- object
- Description
A list of items associated to the card involved in the transaction, including:
iban(string): The IBAN of the cardholder's bank account.bban(string): The Basic Bank Account Number of the cardholder’s account in its local format.pan(string): The Primary Account Number of the card used in the transaction, typically unmasked for internal processing.maskedPan(string): The masked version of the Primary Account Number for display, hiding sensitive digits for security.msisdn(string): The Mobile Station Integrated Services Digital Network Number associated with the cardholder or transaction.currency(string): The currency code in which the transaction was originally processed, following ISO 4217 standard (e.g., USD, EUR).
- Name
cardTransactions- Type
- object
- Description
A list or array containing individual card transaction records associated with the
card-id, where each object includes:-
booked (array): Data related to a booked card transaction, including:cardTransactionId(string): A unique identifier for the specific card transaction.terminalId(string): A unique identifier of the terminal or point-of-sale device where the transaction was initiated.transactionDate(date-time): The date when the transaction occurred, formatted asYYYY-MM-DD.bookingDate(date-time): The date on which the transaction was recorded in the account ledger, formatted asYYYY-MM-DD.transactionAmount(object): Amount of the transaction in the original or source currency before any conversion, including:currency(string): The currency code in which the transaction was originally processed, following ISO 4217 standard (e.g., USD, EUR).Amount(string): The total amount involved in the transaction expressed in the transaction currency.
currencyExchange(array): The currency exchange information applied to the transaction, including rates and currencies involved:sourceCurrency(string): The currency code representing the original currency of the transaction before conversion, following ISO 4217 standard (e.g., USD, EUR).exchangeRate(string): The rate used to convert the transaction amount from the source currency to the target currency.unitCurrency(string): The currency code representing the unit of measure for the transaction amount or exchange, following ISO 4217 standard (e.g., USD, EUR).targetCurrency(string): The currency code representing the target currency to which the transaction amount was converted, following ISO 4217 standard (e.g., USD, EUR).quotationDate(date-time): The date on which the exchange rate or quotation was applied, formatted asYYYY-MM-DD.contractIdentification(string): A Unique identifier assigned to the contract associated with the transaction.
originalAmount(object): The original transaction amount before any fees or currency conversions, including:currency(string): The currency code in which the transaction was originally processed.Amount(string): The final amount charged in the transaction, including any fees or adjustments.
markupFee(object): The absolute fee amount added to the original transaction as a markup, including:currency(string): The ISO 4217 currency code representing the currency in which the transaction amount is denominated.Amount(string): The final amount charged in the transaction, including any fees or adjustments.
markupFeePercentage(string): The percentage rate applied as a markup fee on the original transaction amount.cardAcceptorId(string): A unique identifier assigned to the merchant or card acceptor.cardAcceptorAddress(object): The full address of the merchant or location where the transaction occurred, including:street(string): The street address of the merchant or card acceptor associated with the transaction.buildingNumber(string): The building number component of the merchant's address.city(string): The city where the merchant or card acceptor is located.postalCode(string): The postal or ZIP code of the merchant's location.country(string): The two-letter ISO country code where the transaction was processed.
merchantCategoryCode(string): A numeric code that classifies the merchant's primary business category.maskedPAN(string): The masked Primary Account Number (PAN) of the card used in the transaction, showing only the last few digits for security.transactionDetails: Additional descriptive information or metadata related to the transaction.invoiced(boolean): Boolean flag indicating whether the transaction has been invoiced.proprietaryBankTransactionCode(string): A bank-specific code used to categorize or identify the transaction.
-
pending(array): Pending transaction data, including:cardTransactionId(string): A unique identifier for the specific card transaction.terminalId(string): A unique identifier of the terminal or point-of-sale device where the transaction was initiated.transactionDate(date-time): The date when the transaction occurred, formatted asYYYY-MM-DD.bookingDate(date-time): The date on which the transaction was recorded in the account ledger, formatted asYYYY-MM-DD.transactionAmount(string): Amount of the transaction in the original or source currency before any conversion, including:currency(string): The currency code in which the transaction was originally processed, following ISO 4217 standard (e.g., USD, EUR).Amount(string): The total amount involved in the transaction expressed in the transaction currency.
currencyExchange(array): The currency exchange information applied to the transaction, including rates and currencies involved:sourceCurrency(string): The currency code representing the original currency of the transaction before conversion, following ISO 4217 standard (e.g., USD, EUR).exchangeRate(string): The rate used to convert the transaction amount from the source currency to the target currency.unitCurrency(string): The currency code representing the unit of measure for the transaction amount or exchange, following ISO 4217 standard (e.g., USD, EUR).targetCurrency(string): The currency code representing the target currency to which the transaction amount was converted, following ISO 4217 standard (e.g., USD, EUR).quotationDate(date-time): The date on which the exchange rate or quotation was applied, formatted asYYYY-MM-DD.contractIdentification: A unique identifier assigned to the contract associated with the transaction.
originalAmount(object): The original transaction amount before any fees or currency conversions, including:currency(string): The currency code in which the transaction was originally processed.Amount(string): The final amount charged in the transaction, including any fees or adjustments.
markupFee(object): The absolute fee amount added to the original transaction as a markup, including:currency(string): The ISO 4217 currency code representing the currency in which the transaction amount is denominated.Amount(string): The final amount charged in the transaction, including any fees or adjustments.
markupFeePercentage(string): The percentage rate applied as a markup fee on the original transaction amount.cardAcceptorId(string): A unique identifier assigned to the merchant or card acceptor.cardAcceptorAddress(object): The detailed address information of the merchant or card acceptor, including:street(string): The street address of the merchant or card acceptor associated with the transaction.buildingNumber(string): The building or unit number in the merchant’s address where the transaction occurred.city(string) :The city where the merchant or card acceptor is located.postalCode(string): The postal or ZIP code of the merchant’s address.country(string): The country code where the transaction was processed, represented in ISO 3166-1 alpha-2 format.
merchantCategoryCode(string): The standardized code representing the merchant’s category or business type.maskedPAN(string): The card number with sensitive digits masked for security purposes.transactionDetails(string): An object providing detailed information about the transaction including type and status.invoiced(boolean): A boolean flag indicating whether the transaction has been invoiced.proprietaryBankTransactionCode(string): A bank-specific transaction code used for internal processing and reconciliation.links(object): An object containing URLs related to the transaction for additional resources or actions.
-
- Name
balances- Type
- array(object)
- Description
An object containing different balance types and their corresponding amounts related to the card:
balanceAmount(object): The amount associated with the specified balance type, including currency and value details:currency(string): The original currency code of the transaction amount.Amount(string): The monetary value associated with a specific transaction or balance, including currency information.
balanceType(integer): The type of the balance being reported. Available options:- 0:
closingBooked - 1:
expected - 2:
authorised - 3:
openingBooked - 4:
interimAvailable - 5:
interimBooked - 6:
forwardAvailable - 7:
nonInvoiced
- 0:
creditLimitIncluded(boolean): Indicates whether the credit limit amount is included in the balance calculations; true if included, false otherwise.lastChangeDateTime(date-time): The timestamp indicating the last time the transaction data or related card information was modified, formatted as ISO 8601.referenceDate(date-time): The date for which the transaction balances and details are referenced, formatted as an ISO 8601 date string.lastCommittedTransaction(string): Details of the most recent transaction that has been fully processed and committed to the account.
- Name
links- Type
- object
- Description
A collection of URLs or hyperlinks relevant to the transaction response, such as related resources or actions.
- Name
authenticationSchemes- Type
- array(string)
- Description
The list of authentication methods used or required to access the card transactions, such as OAuth or API key.
- Name
properties- Type
- object
- Description
A dictionary of additional attributes or metadata related to the response or transactions.
items: An array of individual transaction objects associated with the card specified by the card ID.
- Name
statusCode- Type
- integer
- Description
The HTTP status code returned by the API, indicating the result of the transaction request.
- Name
tppMessages- Type
- array (object)
- Description
Messages generated by Third Party Providers (TPPs) that contain information or warnings related to the transaction request:
category(integer): The message category of the error. Available options:- 0:
ERROR - 1:
WARNING
- 0:
code(integer): The error or warning code returned by the API. Available options:- 0:
FORMATERROREnum - 1:
PARAMETERNOTCONSISTENTEnum - 2:
PARAMETERNOTSUPPORTEDEnum - 3:
SERVICEINVALIDEnum - 4:
RESOURCEUNKNOWNEnum - 5:
RESOURCEEXPIREDEnum - 6:
RESOURCEBLOCKEDEnum - 7:
TIMESTAMPINVALIDEnum - 8:
PERIODINVALIDEnum - 9:
SCAMETHODUNKNOWNEnum - 10:
CONSENTUNKNOWNEnum - 11:
SESSIONSNOTSUPPORTEDEnum - 12:
INVALIDTOTALAMOUNTEnum
- 0:
path(string): The resource path indicating the endpoint location for the card transactions request.text(string): A descriptive message providing additional context or details related to the response.
- Name
links- Type
- object
- Description
Hypermedia links providing URLs to related resources or actions associated with the current response.
Request
curl -X GET /v1/accounts/{account-id}/transactions \
-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
{
"cardAccount": {
"iban": "",
"bban": "",
"pan": "",
"maskedPan": "",
"msisdn": "",
"currency": ""
},
"cardTransactions": {
"booked": [
{
"cardTransactionId": "",
"terminalId": "",
"transactionDate": "",
"bookingDate": "",
"transactionAmount": {
"currency": "",
"Amount": ""
},
"currencyExchange": [
{
"sourceCurrency": "",
"exchangeRate": "",
"unitCurrency": "",
"targetCurrency": "",
"quotationDate": "",
"contractIdentification": ""
}
],
"originalAmount": {
"currency": "",
"Amount": ""
},
"markupFee": {
"currency": "",
"Amount": ""
},
"markupFeePercentage": "",
"cardAcceptorId": "",
"cardAcceptorAddress": {
"street": "",
"buildingNumber": "",
"city": "",
"postalCode": "",
"country": ""
},
"merchantCategoryCode": "",
"maskedPAN": "",
"transactionDetails": "",
"invoiced": false,
"proprietaryBankTransactionCode": ""
}
],
"pending": [
{
"cardTransactionId": "",
"terminalId": "",
"transactionDate": "",
"bookingDate": "",
"transactionAmount": {
"currency": "",
"Amount": ""
},
"currencyExchange": [
{
"sourceCurrency": "",
"exchangeRate": "",
"unitCurrency": "",
"targetCurrency": "",
"quotationDate": "",
"contractIdentification": ""
}
],
"originalAmount": {
"currency": "",
"Amount": ""
},
"markupFee": {
"currency": "",
"Amount": ""
},
"markupFeePercentage": "",
"cardAcceptorId": "",
"cardAcceptorAddress": {
"street": "",
"buildingNumber": "",
"city": "",
"postalCode": "",
"country": ""
},
"merchantCategoryCode": "",
"maskedPAN": "",
"transactionDetails": "",
"invoiced": false,
"proprietaryBankTransactionCode": ""
}
],
"links": {}
},
"balances": [
{
"balanceAmount": {
"currency": "",
"Amount": ""
},
"balanceType": 0,
"creditLimitIncluded": false,
"lastChangeDateTime": "",
"referenceDate": "",
"lastCommittedTransaction": ""
}
],
"links": {}
}
Responses
| Status | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
Fetch card balances
Retrieve detailed balance information for a specific card, addressed by card-id, including various balance types and credit limits.
Monitor the current financial status and available funds associated with your card in real time.
Path parameters
- Name
card-id- Type
- string
- Description
The unique identifier of the card for which the balance information is requested.
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 (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
Response attributes
- Name
card-account- Type
- object
- Description
Details of the account associated with the card, including:
iban(string): The International Bank Account Number (IBAN) associated with the card account for international transactions.bban(string): The Basic Bank Account Number linked to the card, used for domestic bank transfers and identification.pan(string): The full Primary Account Number of the card, provided only when authorized and securely handled.maskedPan(string): The card number masked to protect sensitive information, typically showing only the last four digits.msisdn(string): The Mobile Station International Subscriber Directory Number (MSISDN) linked to the cardholder, if applicable.currency(string): The three-letter ISO 4217 currency code for the amount specified in the balance or transaction.
- Name
balances- Type
- array
- Description
A collection of balance objects associated with the card, detailing various balance types, each containing:
balanceAmount(object): The monetary amount for a specific balance, represented in the associated currency. It includes:currency(string): The three-letter ISO 4217 currency code for the amount specified in the balance or transaction.Amount(string): Monetary value consisting of an amount and its currency, representing a balance or transaction value.
balanceType(integer): The type of the balance. Available options:- 0:
closingBooked - 1:
expected - 2:
authorised - 3:
openingBooked - 4:
interimAvailable - 5:
interimBooked - 6:
forwardAvailable - 7:
nonInvoiced
- 0:
creditLimitIncluded(boolean): Indicates whether the credit limit is included in the balance amounts.lastChangeDateTime(date-time): Timestamp of the last update made to the balance information, formatted as an ISO 8601 date-time.referenceDate(date-time): The date on which the balance information is based, formatted as an ISO 8601 date.lastCommittedTransaction(string): Details of the most recent transaction that affected the balance, including identifiers and timestamps.
- Name
authenticationSchemes- Type
- array(string)
- Description
The list of authentication methods used, supported or required for the API request to ensure secure access control.
- Name
properties- Type
- object
- Description
Additional metadata or attributes related to the response object. It includes:
items(array): An array of balance objects representing individual card balance entries returned by the endpoint.
- Name
statusCode- Type
- integer
- Description
The HTTP status code indicating the result of the API request.
- Name
tppMessages- Type
- object
- Description
Messages from the Third Party Provider (TPP), including informational notes, warnings, or errors relevant to the request processing. It includes:
category(integer): The message category of the error. Available options:- 0:
ERROR - 1:
WARNING
- 0:
code(integer): The error or warning code returned by the API. Available options:- 0:
CERTIFICATEINVALIDEnum - 1:
CERTIFICATEEXPIREDEnum - 2:
CERTIFICATEBLOCKEDEnum - 3:
CERTIFICATEREVOKEEnum - 4:
CERTIFICATEMISSINGEnum - 5:
SIGNATUREINVALIDEnum - 6:
SIGNATUREMISSINGEnum - 7:
CORPORATEIDINVALIDEnum - 8:
PSUCREDENTIALSINVALIDEnum - 9:
CONSENTINVALIDEnum - 10:
CONSENTEXPIREDEnum - 11:
TOKENUNKNOWNEnum - 12:
TOKENINVALIDEnum - 13:
TOKENEXPIREDEnum
- 0:
path(string): The request path or resource location relevant to the response, aiding in tracing and logging operations.text(string): A description or message associated with the response, useful for debugging or user display.
- Name
links- Type
- object
- Description
URLs for navigation or further actions associated with the response.
Request
curl -X GET /v1/cards/{card-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
{
"cardAccount": {
"iban": "",
"bban": "",
"pan": "",
"maskedPan": "",
"msisdn": "",
"currency": ""
},
"balances": [
{
"balanceAmount": {
"currency": "",
"Amount": ""
},
"balanceType": 0,
"creditLimitIncluded": false,
"lastChangeDateTime": "",
"referenceDate": "",
"lastCommittedTransaction": ""
}
]
}
Responses
| Status | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
Create consent
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.
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 (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
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
-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
| Status | Description |
|---|---|
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
Delete consent
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 signature verification (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
Response attributes
- 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
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
No Content
Responses
| Status | Description |
|---|---|
| 204 | No Content |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
Fetch consent details
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 (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
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
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
| Status | Description |
|---|---|
| 200 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
Fetch consent authorisation
Retrieve authorisation details for a specific consent, identified by consentId.
Get authorisation information associated with a given consent, helping in managing user authorisation flows in accordance with PSD2 requirements.
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 (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
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
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
| Status | Description |
|---|---|
| 200 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
Start consent authorisation
Initiate the authorisation process for a specific consent.
Trigger the authentication flow and select the appropriate authentication method.
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 (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
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
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
| Status | Description |
|---|---|
| 200 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
Check consent SCA status
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 signature verification (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
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
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
| Status | Description |
|---|---|
| 200 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |
Check consent 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
The certificate used for signature verification (Certificate on Devs Portal App).
- Name
ClientId- Type
- string
- Description
The client ID associated with the request (Application ID on Devs Portal App).
- 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 (Subscription Key on Devs Portal App).
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
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
| Status | Description |
|---|---|
| 200 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 429 | Too Many Requests |