Connexis Cash PSD2 Account Information API (STET) is one of 8 APIs that Connexis Cash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AISP, PSD2, REST, and STET. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and an API reference.
This API exposes
4 operations
across 4 paths,
and defines 60 schemas.
It is described by OpenAPI 3.0.0, at version 2.0.0.
Requests are made against a single base URL, https://api.sandbox.cib.bnpparibas.com/gb-account-information-psd2-stet-mock.
The identity and technical contract details declared by the specification.
ErrorModel
object
Generic error report structure
5 properties
2 required
GenericLink
object
hypertext reference
2 properties
1 required
PsuContextLinks
object
Links that can be used for further navigation when browsing Account Information at top level - self: link to the list of all available accounts
6 properties
1 required
AccountLinks
object
links that can be used for further navigation when browsing Account Information at one account level - balances: link to the balances of a given account - tran…
2 properties
BalancesLinks
object
links that can be used for further navigation when browsing Account Information at one account level - self: link to the balances of a given account - parent-l…
3 properties
1 required
TransactionsLinks
object
links that can be used for further navigation when browsing Account Information at one account level - self: link to the transactions of a given account - pare…
7 properties
1 required
BeneficiariesLinks
object
links that can be used for further navigation when browsing Account Information at one account level - self: link to the beneficiaries - parent-list: link to t…
6 properties
1 required
PaymentRequestLinks
object
links that can be used for further navigation when having post a Payment Request in order to get the relevant status report.
2 properties
PaymentCoverageReportLinks
object
links that can be used for further navigation to post another coverage request.
1 property
1 required
PaymentRequestResourceCreationLinks
object
links that can be used for further navigation, especially in REDIRECT approach
1 property
AppliedAuthenticationApproach
string
The ASPSP, based on the authentication approaches proposed by the PISP, choose the one that it can processed, in respect with the preferences and constraints o…
GenericIdentification
object
ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type…
3 properties
AccountIdentification
object
Unique and unambiguous identification for the account between the account owner and the account servicer.
2 properties
1 required
AmountType
object
ISO20022: structure aiming to carry either an instructed amount or equivalent amount. Both structures embed the amount and the currency to be used. API: only i…
2 properties
2 required
ClearingSystemMemberIdentification
object
ISO20022: Information used to identify a member within a clearing system. API: to be used for some specific international credit transfers in order to identify…
2 properties
FinancialInstitutionIdentification
object
ISO20022: Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification schem…
4 properties
1 required
PostalAddress
object
ISO20022 : Information that locates and identifies a specific address, as defined by postal services.
2 properties
2 required
PartyIdentification
object
API : Description of a Party which can be either a person or an organization.
4 properties
1 required
ResourceId
string
API: Identifier assigned by the ASPSP for further use of the created resource through API calls
PaymentIdentification
object
ISO20022: Set of elements used to reference a payment instruction.
3 properties
2 required
PriorityCode
string
ISO20022: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruct…
CategoryPurposeCode
string
ISO20022: Specifies the high level purpose of the instruction based on a set of pre-defined categories. This is used by the initiating party to provide informa…
ServiceLevelCode
string
ISO20022: Agreement under which or rules under which the transaction should be processed. Specifies a pre-agreed service or level of service between the partie…
LocalInstrumentCode
string
ISO20022: User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the servi…
PaymentTypeInformation
object
ISO20022: Set of elements used to further specify the type of transaction.
4 properties
1 required
PurposeCode
string
ISO20022: Underlying reason for the payment transaction, as published in an external purpose code list. API: The following values are allowed for Payment Reque…
ChargeBearerCode
string
ISO20022: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. API: The following values are allowed…
UnstructuredRemittanceInformation
array
ISO20022: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an acc…
PaymentInformationStatusCode
string
ISO20022: Specifies the status of the payment information. API: Mandatory. The following values are allowed to provide the status of the Payment Request - ACCP…
TransactionIndividualStatusCode
string
ISO20022: Specifies the status of the payment information group. API: Only the following values are allowed to provide the status of the subsequent CREDIT TRAN…
StatusReasonInformation
string
ISO20022: Provides detailed information on the status reason. API: Can only be used in status equal to "RJCT". Only the following values are allowed: - AC01 (I…
RegulatoryReportingCode
string
Information needed due to regulatory and statutory requirements. Economical codes to be used are provided by the National Competent Authority
RegulatoryReportingCodes
array
List of needed regulatory reporting codes for international payments
RequestedExecutionDate
string
ISO20022: Date at which the initiating party requests the clearing agent to process the payment. API: This date can be used in the following cases: - the singl…
EndDate
string
The last applicable day of execution for a given standing order. If not given, the standing order is considered as endless.
ExecutionRule
string
Execution date shifting rule for standing orders This data attribute defines the behaviour when recurring payment dates falls on a weekend or bank holiday. The…
FrequencyCode
string
Frequency rule for standing orders. The following codes from the "EventFrequency7Code" of ISO 20022 are supported. - DAIL: Daily - WEEK: Weekly - TOWK: EveryTw…
CreditTransferTransaction
object
ISO20022: Payment processes required to transfer cash from the debtor to the creditor. API:
12 properties
3 required
SupplementaryData
object
ISO20022: Additional information that cannot be captured in the structured elements and/or any other specific block. API: This structure is used to embed the r…
5 properties
BalanceStatus
string
Type of balance - CLBD: (ISO20022 ClosingBooked) Accounting Balance - XPCD: (ISO20022 Expected) Instant Balance - VALU: Value-date balance - OTHR: Other Balance
TransactionStatus
string
Type of Transaction - BOOK: (ISO20022 ClosingBooked) Accounted transaction - PDNG: (ISO20022 Expected) Instant Balance Transaction - OTHR: Other
Transaction
object
structure of a transaction
9 properties
5 required
AccountResource
object
PSU account that is made available to the TPP
13 properties
4 required
BalanceResource
object
Structure of an account balance
6 properties
3 required
ConfirmationResource
object
Confirmation request resource
1 property
PaymentInformationId
string
ISO20022 : Reference assigned by a sending party to unambiguously identify the payment information block within the message.
CreationDateTime
string
ISO20022: Date and time at which a (group of) payment instruction(s) was created by the instructing party.
FundsAvailabilityInformation
boolean
indicator that the payment can be covered or not by the funds available on the relevant account - true: payment is covered - false: payment is not covered
BookingInformation
boolean
indicator that the payment can be immediately booked or not - true: payment is booked - false: payment is not booked
PaymentRequestResource
object
ISO20022: The PaymentRequestResource message is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a C…
20 properties
10 required
PaymentCoverageRequestResource
object
Payment coverage request structure. The request must rely either on a cash account or a payment card.
4 properties
3 required
HalAccounts
object
HYPERMEDIA structure used for returning the list of the available accounts to the AISP
3 properties
2 required
HalBalances
object
HYPERMEDIA structure used for returning the list of the relevant balances for a given account to the AISP
2 properties
2 required
HalTransactions
object
HYPERMEDIA structure used for returning the list of the transactions for a given account to the AISP
2 properties
2 required
HalPaymentRequest
object
HYPERMEDIA structure used for returning the original Payment Request to the PISP
2 properties
2 required
HalPaymentRequestCreation
object
data forwarded by the ASPSP top the PISP after creation of the Payment Request resource creation
2 properties
HalPaymentCoverageReport
object
HYPERMEDIA structure used for returning the payment coverage report to the PIISP
3 properties
3 required
Beneficiary
object
Specification of a beneficiary
5 properties
2 required
HalBeneficiaries
object
HYPERMEDIA structure used for returning the list of the whitelisted beneficiaries
2 properties
2 required
gatewayErrors
string
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Connexis Cash publishes across the network.
