Confirmation Of Funds API
production
development
https://apigate.dskbank.bg/dsk
Paths
/funds-confirmations
post /funds-confirmations
Funds
Confirmation of Funds Request
Checks whether funds are available for a payment transaction on an account linked with a given tuple cardissuer/cardnumber, or an IBAN and TPP respectively. The currency of requested funds must be the same as PSU`s account currency.
OAuth2
OAuth2
(oauth2 accessCode)
Authorization URL
https://oauth.dskbank.bg/connect/authorize
Token URL
https://oauth.dskbank.bg/connect/token
Scopes
cfs
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
X-Request-ID
Required in header
string / uuid
ID of the request, unique to the call, as determined by the initiating party.
{
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
Request Body
Required in body
object
Funds confirmation request body.
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
OK
{
"schema": {
"type": "object",
"required": [
"fundsAvailable"
],
"properties": {
"fundsAvailable": {
"type": "string",
"description": "Equals “true” if sufficient funds are available at the time of the request, “false” otherwise."
}
},
"example": {
"fundsAvailable": "true"
}
},
"headers": {
"X-Request-ID": {
"type": "string",
"description": "ID of the request, unique to the call, as determined by the initiating party."
}
}
}
400
Bad Request
500
Internal Server Error
Example Request
Example Response
POST https://apigate.dskbank.bg/dsk/prod/v1/funds-confirmations
Definitions
{
"type": "object",
"required": [
"currency",
"amount"
],
"properties": {
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}",
"description": "ISO 4217 code of account currency",
"default": "BGN"
},
"amount": {
"type": "string",
"pattern": "^[0-9]\\d{0,13}(\\.\\d{1,2})?$",
"default": "25.40"
}
}
}
{
"type": "object",
"required": [
"iban"
],
"properties": {
"iban": {
"type": "string",
"default": "BG52STSA99887766554433"
}
}
}
{
"type": "object",
"properties": {
"tppMessages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"type": "string"
},
"code": {
"type": "string"
},
"text": {
"type": "string"
}
}
}
}
}
}
{
"type": "object",
"required": [
"account",
"instructedAmount"
],
"properties": {
"cardNumber": {
"type": "string",
"description": "Card Number of the card issued by the PIISP. Must be delivered if available.",
"default": "31231242"
},
"account": {
"description": "Account number",
"$ref": "#\/definitions\/AccountReference"
},
"payee": {
"type": "string",
"description": "The merchant where the card is accepted as an information to the PSU.",
"default": "Магазин 1 ООД"
},
"instructedAmount": {
"description": "Transaction amount to be checked within the funds check mechanism.",
"$ref": "#\/definitions\/Amount"
}
}
}