Check funds availability

POST 
/v1/funds-confirmations

🧪Try it

Test this endpoint in real-time with customizable parameters and see live responses.

Description

Verify the availability of funds for a specified account or transaction.

tip

Determine if there are sufficient funds to complete a transaction, helping to prevent potential payment failures or overdrafts.

Request

Header Parameters

consentId stringrequired

The unique identifier for the consent provided by the user.

X-Request-ID uuidrequired

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

Certificate stringrequired

The certificate used for signature verification.

ClientId stringrequired

The client ID associated with the request.

Ocp-Apim-Subscription-Key stringrequired

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

application/json

Body parameters

cardNumber stringrequired

The full card number associated with the transaction for funds confirmation.

accountobjectrequired
The account details to be checked for funds availability, relevant to the transaction.
iban stringThe International Bank Account Number (IBAN) for the payee's bank account.
bban stringThe Basic Bank Account Number (BBAN) for the payee's bank account.
pan stringThe primary Account Number (PAN) for the payee's bank account.
maskedPan stringThe partially masked PAN for the payee's bank account.
msisdn stringThe mobile station international subscriber directory number (MSISDN) for the payee's account.
currency stringThe currency type for the funds confirmation request.
payee stringThe name of the payee for the funds confirmation.
instructedAmountobjectrequired
The specified amount for the transaction.
currency stringThe currency type for the transaction.
Amount stringThe amount for the transaction.

Responses

200

OK

application/json

Schema

Schema

fundsAvailable boolean

Indicates whether the funds are available for the requested transaction.

Example (from schema)

{
  "fundsAvailable": true
}

400

Bad Request

application/json

Schema

Schema

tppMessages object[]The messages related to third-party providers (TPPs) included in the response.
Array [
category int32
The category classification of the TPP message.
Available options: 0 = "ERROR", 1 = "WARNING".
code int32
The specific error code returned in the response. Available options: 0-12.
path stringThe path where the TPP message is located.
text stringThe text of the TPP message.
]
links objectThe hyperlinks or references included in the response data.

Example (from schema)

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

401

Unauthorized

application/json

Schema

Schema

statusCode int32The status code indicating the result of the funds confirmation request.
tppMessages object[]The messages related to third-party providers (TPPs) included in the response.
Array [
category int32
The category classification of the TPP message.
Available options: 0 = "ERROR", 1 = "WARNING".
code int32
The specific error code returned in the response. Available options: 0-13.
path stringThe path where the TPP message is located.
text stringThe text of the TPP message.
]
links objectThe hyperlinks or references included in the response.

Example (from schema)

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

403

Forbidden

application/json

Schema

Schema

tppMessages object[]The messages related to third-party providers (TPPs) included in the response.
Array [
category int32
The category classification of the TPP message.
Available options: 0 = "ERROR", 1 = "WARNING".
code int32
The specific error code returned in the response.
Available options:
0 = "CONSENTUNKNOWNEnum"
1 = "SERVICEBLOCKEDEnum"
2 = "RESOURCEUNKNOWNEnum"
3 = "RESOURCEEXPIREDEnum"
path stringThe path where the TPP message is located.
text stringThe text of the TPP message.
]
links objectThe hyperlinks or references included in the response data.

Example (from schema)

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

404

Not found

application/json

Schema

Schema

tppMessages object[]The messages related to third-party providers (TPPs) included in the response.
Array [
category int32
The category classification of the TPP message.
Available options: 0 = "ERROR", 1 = "WARNING".
code int32
The specific error code returned in the response.
Available options: 0 = "INVALIDEnum".
path stringThe path where the TPP message is located.
text stringThe text of the TPP message.
]
links objectThe hyperlinks or references included in the response data.

Example (from schema)

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

405

Method Not Allowed

application/json

Schema

Schema

tppMessages object[]The messages related to third-party providers (TPPs) included in the response.
Array [
category int32
The category classification of the TPP message.
Available options: 0 = "ERROR", 1 = "WARNING".
code int32
The specific error code returned in the response.
Available options: 0 = "INVALIDEnum".
path stringThe path where the TPP message is located.
text stringThe text of the TPP message.
]
links objectThe hyperlinks or references included in the response data.

Example (from schema)

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

409

Conflict

application/json

Schema

Schema

tppMessages object[]The messages related to third-party providers (TPPs) included in the response.
Array [
category int32
The category classification of the TPP message.
Available options: 0 = "ERROR", 1 = "WARNING".
code int32
The specific error code returned in the response.
Available options: 0 = "INVALIDEnum".
path stringThe path where the TPP message is located.
text stringThe text of the TPP message.
]
links objectThe hyperlinks or references included in the response data.

Example (from schema)

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

Loading...