--- title: "Payment coverage check request (CBPII)" method: POST path: "/funds-confirmations" tags: ["CBPII"] --- # Payment coverage check request (CBPII) `POST /funds-confirmations` ## Request - Base URL: `https://www.30007.live.api.natixis.com/stet/psd2/v1.6.2` - URL: `https://www.30007.live.api.natixis.com/stet/psd2/v1.6.2/funds-confirmations` - Auth: one of: - OAuth 2 - Authorization code: `https://oauth2.aspsp/authorization` - Token URL: `https://oauth2.aspsp/token` scopes: `cbpii` - OAuth 2 - Client credentials - Token URL: `https://oauth2.aspsp/token` scopes: `cbpii` ### Description The CBPII can ask an ASPSP to check if a given amount can be covered by the liquidity that is available on a PSU cash account or payment card. ### Prerequisites - The TPP was registered by the Registration Authority for the CBPII role - The TPP and the PSU have a contract that was registered by the ASPSP - At this step, the ASPSP has delivered an "Authorization Code", a "Resource Owner Password" or a "Client Credential" OAUTH2 access token to the TPP (cf. ยง 3.4.2). - Each ASPSP has to implement either the "Authorization Code"/"Resource Owner Password" or the "Client Credential" OAUTH2 access token model. - Doing this, it will edit the [security] section on this path in order to specify which model it has chosen - The TPP and the ASPSP have successfully processed a mutual check and authentication - The TPP has presented its OAUTH2 "Authorization Code", "Resource Owner Password" or "Client Credential" access token which allows the ASPSP to identify the relevant PSU. ### Business flow The CBPII requests the ASPSP for a payment coverage check against either a bank account or a card primary identifier. This request cannot handle exchange rate and must be specified with the relevant account currency. The ASPSP answers with a structure embedding the original request and the result as a Boolean. ## Headers - `Authorization` string, required - `PSU-IP-Address` string - `PSU-IP-Port` string - `PSU-HTTP-Method` string - `PSU-Date` string - `PSU-GEO-Location` string - `PSU-User-Agent` string - `PSU-Referer` string - `PSU-Accept` string - `PSU-Accept-Charset` string - `PSU-Accept-Encoding` string - `PSU-Accept-Language` string - `PSU-Device-ID` string - `Digest` string - `Signature` string, required - `X-Request-ID` string, required ## Request body - PaymentCoverageRequestResource: Payment coverage request structure. The request must rely either on a cash account or a payment card. The [instructedAmount] property is the payment account on wihich the request is processed. This amount must be positive. Amounts must always be set as positive values. - `paymentCoverageRequestId` string, required: Identification of the payment Coverage Request - `payee` string: The merchant where the card is accepted as information to the PSU. - `instructedAmount` AmountType: Structure aiming to embed the amount and the currency to be used. - `amount` number, float, required: ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. - `currency` string, required: Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". - `accountId` AccountIdentification, required: Unique and unambiguous identification for the account between the account owner and the account servicer. Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN). The currency used for the account, when needed, can be specified through the [currency] field. - `workspace` string: Workspace to which the account is linked. This workspace might be specified by the AISP when forwarding the consent on accounts. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token. - `iban` string: ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions. - `other` GenericIdentification: 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 it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `currency` string: Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". ## Response `200` payment coverage request - HalPaymentCoverageReport: HYPERMEDIA structure used for returning the payment coverage report to the CBPII - `request` PaymentCoverageRequestResource, required: Payment coverage request structure. The request must rely either on a cash account or a payment card. The [instructedAmount] property is the payment account on wihich the request is processed. This amount must be positive. Amounts must always be set as positive values. - `paymentCoverageRequestId` string, required: Identification of the payment Coverage Request - `payee` string: The merchant where the card is accepted as information to the PSU. - `instructedAmount` AmountType: Structure aiming to embed the amount and the currency to be used. - `amount` number, float, required: ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. - `currency` string, required: Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". - `accountId` AccountIdentification, required: Unique and unambiguous identification for the account between the account owner and the account servicer. Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN). The currency used for the account, when needed, can be specified through the [currency] field. - `workspace` string: Workspace to which the account is linked. This workspace might be specified by the AISP when forwarding the consent on accounts. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token. - `iban` string: ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer. Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions. - `other` GenericIdentification: 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 it will support. - `identification` string, required: API: Identifier - `schemeName` string, required: Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following: | Code | Name | Description | | ---- | ---- | ----------- | | BANK | BankPartyIdentification | Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client. | | BBAN | BBANIdentifier | Basic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer. | | COID | CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number) | | SREN | SIREN | The SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France. | | SRET | SIRET | The SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity. | | NIDN | NationalIdentityNumber | Number assigned by an authority to identify the national identity number of a person. | Other values are also permitted, for instance: | Code | Name | Description | | ---- | ---- | ----------- | | OAUT | OAUTH2 | OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU | | CPAN | CardPan | Card PAN | | MPAN | MaskedPan | Card PAN where some digits were replaced for security reason | | TPAN | TokenizedPan | Token which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field | | TBAN | TokenizedIBAN | Token which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field | Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used - `issuer` string: ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties - `currency` string: Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". - `result` boolean, required: Result of the coverage check : - true: the payment can be covered - false: the payment cannot be covered - `_links` PaymentCoverageReportLinks, required: links that can be used for further navigation to post another coverage request. - `self` GenericLink, required: hypertext reference - `href` string, required: URI to be used. HREF stands for Hypertext REFerence. - `templated` boolean: This field must be set with "true" when [href] is an URI template, i.e. with parameters that will be set by the client afterwards. Parameter fields must be included by the API server according to RFC6570. Otherwise, this property must be absent or set to false default value: false ## Other responses - `400`: Invalid status value - `401`: Unauthorized, authentication failure. - `403`: Forbidden, authentication successful but access to resource is not allowed. - `405`: Method Not Allowed. - `406`: Not Acceptable. - `408`: Request Timeout. - `429`: Too many requests. - `500`: Internal server error. - `503`: Service unavailable. --- [API](https://skmtc.dev/groupebpce/apis/natixis-funds-availability.md) - [All operations](https://skmtc.dev/groupebpce/apis/natixis-funds-availability/llms.txt) - [OpenAPI document](https://skmtc.dev/groupebpce/apis/natixis-funds-availability/revisions/7760e126f389?raw)