FCS (v1.0)

Download OpenAPI specification:Download

API Support: info-api@abanca.com

Authentication

BearerAuthOAuth

Bearer Token. Is needed, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in an preceding AIS service in the same session.

Security scheme type: HTTP
HTTP Authorization Scheme bearer

Confirmation of Funds Service (PIIS)

Confirmation of Funds Service (PIIS) returns a confirmation of funds request at the bank

Confirmation of Funds Request

Creates a confirmation of funds request at the ABANCA platform. Checks whether a specific amount is available at point of time of the request on an account linked to a given tuple card issuer(TPP)/card number, or addressed by IBAN and TPP respectively

Authorizations:
header Parameters
X-Request-ID
required
string <uuid>
Example: {X-Request-ID}

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

Digest
string
Example: SHA-256%3Dhl1%2FEps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A%3D

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

Date
string
Example: Wed%2C%2021%20Oct%202015%2007%3A28%3A00%20GMT

The general HTTP header contains the date and time at which the message was originated.

Signature
string
Example: keyId%3D%22SN%3D9FA1%2CCA%3DCN%3DD-TRUST%2520CA%25202-1%25202015%2CO%3DD-Trust%2520GmbH%2CC%3DDE%22%2Calgorithm%3D%22rsa-sha256%22%2C%20headers%3D%22Digest%20X-Request-ID%20PSU-ID%20TPP-Redirect-URI%20Date%22%2C%20signature%3D%22Base64%28RSA-SHA256%28signing%20string%29%29%22%0A

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificate
string <byte>

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

Consent-ID
required
string (consentId)
Example: {Consent-ID}

This field contains the consentId of the related API consent, which was performed prior to this funds check invocation.

PSU-IP-Address
required
string <ipv4>
Example: {PSU-IP-Address}

The forwarded IP Address header field consists of the corresponding http request IP Address field between PSU and TPP.

PSU-IP-Port
string
Example: {PSU-IP-Port}

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Accept
string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Charset
string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Encoding
string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Language
string

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-User-Agent
string

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method
string
Enum:"GET" "POST" "PUT" "PATCH" "DELETE"

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
PSU-Device-ID
string <uuid>
Example: {PSU-Device-ID}

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID need to be unaltered until removal from device.

PSU-Geo-Location
string(GEO:)[0-9]{1,3}\.[-][0-9]{6}\,[-][0-9]{1,3}\.[0-9]{6}
Example: {PSU-Geo-Location}

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request Body schema: application/json

Request body for a confirmation of funds request.

cardNumber
string

Card Number of the card issued by the PIISP. Should be delivered if available.

account
required
object (accountReference)

Reference to an account by either

  • IBAN, of a payment accounts
payee
string <= 70 characters

Name payee

instructedAmount
required
object (amount)

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found

405

Method Not Allowed

406

Not Acceptable

408

Request Timeout

415

Unsupported Media Type

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable

post /v1/funds-confirmations

Production server

https://apiserv.novobanco.es/psd2/v1/funds-confirmations

sandbox

https://api.novobanco.es/psd2/sandbox/fcs/v1/funds-confirmations

Request samples

Content type
application/json

Request body for a confirmation of funds.

Copy
Expand all Collapse all
{
  • "cardNumber": "1234567890123456",
  • "account":
    {
    },
  • "instructedAmount":
    {
    }
}

Response samples

Content type
application/json

Response for a confirmation of funds request.

Copy
Expand all Collapse all
{
  • "fundsAvailable": "true"
}