PIS API

PIS API 1.0.0

Description

Payment Initiation Service Provider API

Contact information

DSK Bank

apigate@dskbank.bg

https://www.dskbank.bg

Endpoints

production

development

https://apigate.dskbank.bg/dsk

Paths

/payments/{payment-product}

payments

Summary

This method to initiate a payment initiation at the BDSK can be sent with a JSON body depending on the payment product in the path. There are the following payment products:

domestic-credit-transfers-bgn - Credit payment (local in BGN)
domestic-budget-transfers-bgn - Payment to the BG budget
sepa-credit-transfers - Payment in EUR
cross-border-transfers

Example request body definitions:

pisRequestBodyBGNCreditTransfer
pisRequestBodyBGNBudgetTransfer
pisRequestBodySEPACreditTransfer
pisRequestBodyCrossBorderTransfer

In the test tool is used only general request body with all parameters paymentInitiationServiceRequestBody

Description

Creates a payment initiation resource addressable under {paymentId} with all data relevant for the corresponding payment product. This is the first step in the API to initiate the related payment

Security

clientIdHeader

X-IBM-Client-Id

(apiKey located in header)

OAuth2

(oauth2 accessCode)

Authorization URL

https://identity.dskbank.bg/connect/authorize

Token URL

https://identity.dskbank.bg/connect/token

Scopes

pis.sandbox

Parameters

payment-product

Required in path

string

Types of payment products:

domestic-credit-transfers-bgn
domestic-budget-transfers-bgn
sepa-credit-transfers
cross-border-transfers

{
    "enum": [
        "domestic-credit-transfers-bgn",
        "domestic-budget-transfers-bgn",
        "sepa-credit-transfers",
        "cross-border-transfers"
    ]
}

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}$"
}

PSU-IP-Address

Required in header

string

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

{
    "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"
}

TPP-Redirect-URI

Required in header

string

URI of the TPP, where the transaction flow shall be redirected to after a Redirect

PSU-User-Agent

Optional in header

string

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

PSU-IP-Port

Optional in header

string

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

PSU-Geo-Location

Optional in header

string

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

PSU-Accept

Optional in header

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

Optional in header

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

Optional in header

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

Optional in header

string

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

PSU-Http-Method

Optional in header

string

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

GET
POST
PUT
PATCH
DELETE

{
    "enum": [
        "GET",
        "POST",
        "PUT",
        "PATCH",
        "DELETE"
    ]
}

PSU-Device-ID

Optional in header

string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.

PISBody

Required in body

object

paymentInitiationServiceRequestBody

Content-Type

Optional in header

string

application/json

Optional in header

string

application/json

Responses

201

Created

{
    "schema": {
        "type": "object",
        "required": [
            "transactionStatus",
            "paymentId",
            "_links"
        ],
        "properties": {
            "transactionStatus": {
                "$ref": "#\/definitions\/TransactionStatus"
            },
            "paymentId": {
                "type": "string",
                "description": "resource identification of the generated payment initiation resource."
            },
            "transactionFees": {
                "$ref": "#\/definitions\/Amount",
                "description": "Can be used by the BDSK to transport transaction fees relevant for the underlying payments."
            },
            "transactionFeeIndicator": {
                "type": "boolean",
                "description": "If equals “true”, the transaction will involve specific transaction cost as shown by the BDSK in their public price list or as agreed between BDSK and PSU. If equals “false”, the transaction will not

400

Bad Request

ErrorModel

401

Unauthorized

ErrorModel

403

Forbidden

ErrorModel

500

Internal Server Error

ErrorModel

Example Request

Example Response

Definition

POST https://apigate.dskbank.bg/dsk/v1/payments/{payment-product}

Response

/payments/{payment-product}/{paymentId}

payment

Summary

Returns the content of a payment object

Security

clientIdHeader

X-IBM-Client-Id

(apiKey located in header)

OAuth2

(oauth2 accessCode)

Authorization URL

https://identity.dskbank.bg/connect/authorize

Token URL

https://identity.dskbank.bg/connect/token

Scopes

pis.sandbox

Parameters

payment-product

Required in path

string

Types of payment products:

domestic-credit-transfers-bgn
domestic-budget-transfers-bgn
sepa-credit-transfers
cross-border-transfers

{
    "enum": [
        "domestic-credit-transfers-bgn",
        "domestic-budget-transfers-bgn",
        "sepa-credit-transfers",
        "cross-border-transfers"
    ]
}

paymentId

Required in path

string

Resource identification of the generated payment initiation resource.

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}$"
}

PSU-IP-Address

Optional in header

string

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

{
    "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"
}

PSU-User-Agent

Optional in header

string

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

PSU-IP-Port

Optional in header

string

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

PSU-Geo-Location

Optional in header

string

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

PSU-Accept

Optional in header

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

Optional in header

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

Optional in header

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

Optional in header

string

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

PSU-Http-Method

Optional in header

string

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

GET
POST
PUT
PATCH
DELETE

{
    "enum": [
        "GET",
        "POST",
        "PUT",
        "PATCH",
        "DELETE"
    ]
}

PSU-Device-ID

Optional in header

string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.

Optional in header

string

application/json

Responses

200

{
    "schema": {
        "type": "object",
        "properties": {
            "debtorAccount": {
                "$ref": "#\/definitions\/AccountReference"
            },
            "instructedAmount": {
                "$ref": "#\/definitions\/Amount"
            },
            "creditorAccount": {
                "$ref": "#\/definitions\/AccountReference"
            },
            "creditorName": {
                "type": "string"
            },
            "creditorAddress": {
                "$ref": "#\/definitions\/Address"
            },
            "remittanceInformationUnstructured": {
                "type": "string"
            },
            "serviceLevel": {
                "$ref": "#\/definitions\/ServiceLevelCode"
            },
            "payment-product": {
                "type": "string"
            },
            "transactionStatus": {
                "type": "string"
            }
        },
        "example": {
            "debtorAccount": {
                "

400

Bad Request

ErrorModel

401

Unauthorized

ErrorModel

403

Forbidden

ErrorModel

500

Internal Server Error

ErrorModel

Example Request

Example Response

Definition

GET https://apigate.dskbank.bg/dsk/v1/payments/{payment-product}/{paymentId}

Response

/payments/{payment-product}/{paymentId}/status

payments

Summary

Payment initiation status request

Description

Reads the transaction status of the payment

Security

clientIdHeader

X-IBM-Client-Id

(apiKey located in header)

OAuth2

(oauth2 accessCode)

Authorization URL

https://identity.dskbank.bg/connect/authorize

Token URL

https://identity.dskbank.bg/connect/token

Scopes

pis.sandbox

Parameters

payment-product

Required in path

string

Types of payment products:

domestic-credit-transfers-bgn
domestic-budget-transfers-bgn
sepa-credit-transfers
cross-border-transfers

{
    "enum": [
        "domestic-credit-transfers-bgn",
        "domestic-budget-transfers-bgn",
        "sepa-credit-transfers",
        "cross-border-transfers"
    ]
}

paymentId

Required in path

string

Resource identification of the generated payment initiation resource.

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}$"
}

PSU-IP-Address

Optional in header

string

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

{
    "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"
}

PSU-User-Agent

Optional in header

string

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

PSU-IP-Port

Optional in header

string

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

PSU-Geo-Location

Optional in header

string

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

PSU-Accept

Optional in header

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

Optional in header

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

Optional in header

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

Optional in header

string

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

PSU-Http-Method

Optional in header

string

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

GET
POST
PUT
PATCH
DELETE

{
    "enum": [
        "GET",
        "POST",
        "PUT",
        "PATCH",
        "DELETE"
    ]
}

PSU-Device-ID

Optional in header

string

UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available.

Optional in header

string

application/json

Responses

200

{
    "schema": {
        "type": "object",
        "properties": {
            "transactionStatus": {
                "$ref": "#\/definitions\/TransactionStatus"
            }
        },
        "example": {
            "transactionStatus": "RCVD"
        }
    },
    "headers": {
        "X-Request-ID": {
            "type": "string",
            "description": "ID of the request, unique to the call, as determined by the initiating party."
        }
    }
}

400

Bad Request

ErrorModel

401

Unauthorized

ErrorModel

403

Forbidden

ErrorModel

500

Internal Server Error

ErrorModel

Example Request

Example Response

Definition

GET https://apigate.dskbank.bg/dsk/v1/payments/{payment-product}/{paymentId}/status

Response

Definitions

Amount

{
    "type": "object",
    "required": [
        "currency",
        "amount"
    ],
    "properties": {
        "currency": {
            "type": "string",
            "description": "ISO 4217 Alpha 3 currency code",
            "pattern": "[A-Z]{3}",
            "default": "BGN"
        },
        "amount": {
            "type": "string",
            "pattern": "^[0-9]\\d{0,13}(\\.\\d{1,2})?$",
            "default": "88.55"
        }
    }
}

Address

{
    "type": "object",
    "required": [
        "country"
    ],
    "properties": {
        "street": {
            "type": "string",
            "maxLength": 70
        },
        "buildingNumber": {
            "type": "string"
        },
        "city": {
            "type": "string"
        },
        "postalCode": {
            "type": "string"
        },
        "country": {
            "type": "string",
            "description": "ISO 3166 ALPHA2 country code",
            "example": "SE",
            "pattern": "[A-Z]{2}"
        }
    }
}

ServiceLevelCode

SEPA - Used for SEPA payment
URGP - Used for payments through RTGS System
SDVA - Used for Cross border CT. Payment must be executed with same day value to the creditor
NEXT - Used for Cross border CT. Payment must be executed with next working day value to the creditor
SPOT - Used for Cross border CT. Payment must be executed with spot working day value to the creditor

{
    "type": "string",
    "example": "SEPA",
    "enum": [
        "SEPA",
        "URGP",
        "SDVA",
        "NEXT",
        "SPOT"
    ]
}

PurposeCode

GOVT - Constant marked budget payment

{
    "type": "string",
    "enum": [
        "GOVT"
    ]
}

ChargeBearerCode

DEBT – Borne By Debtor
CRED – Borne By Creditor
SHAR – Shared in Credit Transfer context
SLEV – Usefully in SEPA payments

{
    "type": "string",
    "example": "DEBT",
    "enum": [
        "DEBT",
        "CRED",
        "SHAR",
        "SLEV"
    ]
}

BudgetPaymentDetails

{
    "type": "object",
    "required": [
        "regulatoryReportType"
    ],
    "properties": {
        "regulatoryReportType": {
            "description": "Regulatory Report Type – 1 digit code",
            "$ref": "#\/definitions\/RegulatoryReportType"
        },
        "documentNumber": {
            "description": "Document Number issued by Government authority. documentNumber - mandatory if value of Regulatory Report Type is 2, 3 or 6",
            "type": "string"
        },
        "documentDate": {
            "description": "Document Date issued by Government authority. documentDate mandatory if value of Regulatory Report Type is 2, 3 or 6",
            "type": "string",
            "format": "ISODate",
            "pattern": "([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))",
            "example": "2018-03-17"
        },
        "taxPayerId": {
            "type": "string",
            "pattern": "^[0-9]{1,10}$",
            "maxLength": 10
        },
        "taxPayerType": {
            "description": "Tax Type – 3 CAP letters code",
            "$ref": "#\/definitions\/TaxTypeCode"
        },
        "paymentCategory": {
            "description": "Payment Category – 6 digit code. Mandatory if IBAN of creditorAccount contains \"8\" in position 13.",
            "$ref": "#\/definitions\/PaymentCategoryCode"
        },
        "fromDate": {
            "description": "From Date – start of period date. fromDate mandatory if value of Regulatory Report Type  is 1, 2, 4 or 5",
            "type": "string",
            "format": "ISODate",
            "pattern": "([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))",
            "example": "2019-02-10"
        },
        "endDate": {
            "description": "End Date – end of period date. endDate mandatory if value of Regulatory Report Type is 1, 2, 4 or 5",
            "type": "string",
            "format": "ISODate",
            "pattern": "([12]\\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01]))",
            "example": "2019-08-10"
        }
    }
}

RegulatoryReportType

1 – Declaration
2 – Inspection ACt
3 – Penalty Decree
4 – advance payment
5 – batch property number
6 – enforces collection order
9 – others

{
    "type": "string",
    "enum": [
        "1",
        "2",
        "3",
        "4",
        "5",
        "6",
        "9"
    ]
}

TaxTypeCode

EGN – Personal ID
EIK – Corporate ID
PNF – Foreign Person ID

{
    "type": "string",
    "enum": [
        "EGN",
        "EIK",
        "PNF"
    ],
    "maxLength": 3
}

PaymentCategoryCode

110000 - НАП (NRA)
551111 - НОИ (NSSI)
561111 - НЗОК (NHIF)
581111 - ДЗПО (SCPI)

{
    "type": "string",
    "enum": [
        "110000",
        "551111",
        "561111",
        "581111"
    ],
    "maxLength": 6
}

Links

{
    "type": "object",
    "properties": {
        "scaRedirect": {
            "$ref": "#\/definitions\/Href",
            "description": "A link to a BDSK site where SCA is performed within the Redirect SCA approach."
        },
        "self": {
            "$ref": "#\/definitions\/Href",
            "description": "The link to the payment initiation resource created by the request itself. This link can be used later to retrieve the transaction status of the payment initiation."
        },
        "status": {
            "$ref": "#\/definitions\/Href",
            "description": "The link to retrieve the transaction status of the payment initiation."
        }
    }
}

TransactionStatus

The transaction status is filled with codes of the ISO 20022 data table.

{
    "type": "string",
    "enum": [
        "ACSC",
        "ACSP",
        "ACTC",
        "RCVD",
        "RJCT"
    ]
}

ErrorModel

{
    "type": "object",
    "properties": {
        "tppMessages": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "category": {
                        "type": "string"
                    },
                    "code": {
                        "type": "string"
                    },
                    "text": {
                        "type": "string"
                    }
                }
            }
        }
    }
}

paymentInitiationServiceRequestBody

{
    "type": "object",
    "required": [
        "instructedAmount",
        "debtorAccount",
        "creditorName",
        "creditorAccount"
    ],
    "properties": {
        "endToEndIdentification": {
            "type": "string",
            "maxLength": 35
        },
        "debtorAccount": {
            "$ref": "#\/definitions\/AccountReference"
        },
        "ultimateDebtor": {
            "type": "string",
            "maxLength": 70,
            "description": "Mandatory for: domestic-budget-transfers-bgn. N.A. for: domestic-credit-transfers-bgn, sepa-credit-transfers, cross-border-transfers."
        },
        "instructedAmount": {
            "$ref": "#\/definitions\/Amount"
        },
        "creditorAccount": {
            "$ref": "#\/definitions\/AccountReference"
        },
        "creditorAgent": {
            "type": "string",
            "default": "AAAADEBBXXX",
            "pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
        },
        "creditorAgentName": {
            "type": "string",
            "description": "Mandatory for creditorAccount when payment is cross-border-transfers - If no IBAN used for creditorAccount. N.A. for: domestic-credit-transfers-bgn, domestic-budget-transfers-bgn, sepa-credit-transfers.",
            "maxLength": 70
        },
        "creditorAgentAddress": {
            "description": "Mandatory for creditorAccount when payment is cross-border-transfers - If no IBAN used for creditorAccount. N.A. for: domestic-credit-transfers-bgn, domestic-budget-transfers-bgn, sepa-credit-transfers.",
            "$ref": "#\/definitions\/Address"
        },
        "creditorName": {
            "type": "string",
            "description": "Creditor Name",
            "default": "Търговец ЕООД",
            "maxLength": 70
        },
        "creditorAddress": {
            "description": "Mandatory for: cross-border-transfers. Optional for: domestic-credit-transfers-bgn, domestic-budget-transfers-bgn, sepa-credit-transfers. ",
            "$ref": "#\/definitions\/Address"
        },
        "purposeCode": {
            "description": "Mandatory for: domestic-budget-transfers-bgn. N.A. for: domestic-credit-transfers-bgn, cross-border-transfers, sepa-credit-transfers.",
            "$ref": "#\/definitions\/PurposeCode"
        },
        "chargeBearer": {
            "description": "Mandatory for: cross-border-transfers. Optional for: sepa-credit-transfers. N.A. for: domestic-credit-transfers-bgn, domestic-budget-transfers-bgn.",
            "$ref": "#\/definitions\/ChargeBearerCode"
        },
        "remittanceInformationUnstructured": {
            "type": "string",
            "description": "Mandatory for: domestic-credit-transfers-bgn, domestic-budget-transfers-bgn. Optional for: sepa-credit-transfers, cross-border-transfers.",
            "default": "Ref Number Merchant",
            "maxLength": 140
        },
        "serviceLevel": {
            "description": "Mandatory for: sepa-credit-transfers, cross-border-transfers. Optional for: domestic-credit-transfers-bgn, domestic-budget-transfers-bgn.",
            "$ref": "#\/definitions\/ServiceLevelCode"
        },
        "budgetPaymentDetails": {
            "description": "Mandatory for: domestic-budget-transfers-bgn. N.A. for: domestic-credit-transfers-bgn, sepa-credit-transfers, cross-border-transfers.",
            "$ref": "#\/definitions\/BudgetPaymentDetails"
        }
    }
}

pisRequestBodySEPACreditTransfer

{
    "type": "object",
    "required": [
        "instructedAmount",
        "debtorAccount",
        "creditorName",
        "creditorAccount",
        "serviceLevel"
    ],
    "properties": {
        "endToEndIdentification": {
            "type": "string",
            "maxLength": 35
        },
        "debtorAccount": {
            "$ref": "#\/definitions\/AccountReference"
        },
        "instructedAmount": {
            "$ref": "#\/definitions\/Amount"
        },
        "creditorAccount": {
            "$ref": "#\/definitions\/AccountReference"
        },
        "creditorAgent": {
            "type": "string",
            "default": "AAAADEBBXXX",
            "pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
        },
        "creditorName": {
            "type": "string",
            "description": "Creditor Name",
            "default": "Търговец ЕООД",
            "maxLength": 70
        },
        "chargeBearer": {
            "$ref": "#\/definitions\/ChargeBearerCode"
        },
        "creditorAddress": {
            "$ref": "#\/definitions\/Address"
        },
        "remittanceInformationUnstructured": {
            "type": "string",
            "default": "Ref Number Merchant",
            "maxLength": 140
        },
        "serviceLevel": {
            "$ref": "#\/definitions\/ServiceLevelCode"
        }
    }
}

pisRequestBodyBGNBudgetTransfer

{
    "type": "object",
    "required": [
        "instructedAmount",
        "debtorAccount",
        "ultimateDebtor",
        "creditorName",
        "creditorAccount",
        "purposeCode",
        "remittanceInformationUnstructured",
        "budgetPaymentDetails"
    ],
    "properties": {
        "endToEndIdentification": {
            "type": "string",
            "maxLength": 35
        },
        "debtorAccount": {
            "$ref": "#\/definitions\/AccountReference"
        },
        "ultimateDebtor": {
            "type": "string",
            "maxLength": 70
        },
        "instructedAmount": {
            "$ref": "#\/definitions\/Amount"
        },
        "creditorAccount": {
            "$ref": "#\/definitions\/AccountReference"
        },
        "creditorAgent": {
            "type": "string",
            "default": "AAAADEBBXXX",
            "pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
        },
        "creditorName": {
            "type": "string",
            "description": "Creditor Name",
            "default": "Търговец ЕООД",
            "maxLength": 70
        },
        "creditorAddress": {
            "$ref": "#\/definitions\/Address"
        },
        "purposeCode": {
            "$ref": "#\/definitions\/PurposeCode"
        },
        "remittanceInformationUnstructured": {
            "type": "string",
            "default": "Ref Number Merchant",
            "maxLength": 140
        },
        "serviceLevel": {
            "$ref": "#\/definitions\/ServiceLevelCode"
        },
        "budgetPaymentDetails": {
            "$ref": "#\/definitions\/BudgetPaymentDetails"
        }
    }
}

pisRequestBodyBGNCreditTransfer

{
    "type": "object",
    "required": [
        "instructedAmount",
        "debtorAccount",
        "creditorName",
        "creditorAccount",
        "remittanceInformationUnstructured"
    ],
    "properties": {
        "endToEndIdentification": {
            "type": "string",
            "maxLength": 35
        },
        "debtorAccount": {
            "$ref": "#\/definitions\/AccountReference"
        },
        "instructedAmount": {
            "$ref": "#\/definitions\/Amount"
        },
        "creditorAccount": {
            "$ref": "#\/definitions\/AccountReference"
        },
        "creditorAgent": {
            "type": "string",
            "default": "AAAADEBBXXX",
            "pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
        },
        "creditorName": {
            "type": "string",
            "description": "Creditor Name",
            "default": "Търговец ЕООД",
            "maxLength": 70
        },
        "creditorAddress": {
            "$ref": "#\/definitions\/Address"
        },
        "remittanceInformationUnstructured": {
            "type": "string",
            "default": "Ref Number Merchant",
            "maxLength": 140
        },
        "serviceLevel": {
            "$ref": "#\/definitions\/ServiceLevelCode"
        }
    }
}

pisRequestBodyCrossBorderTransfer

{
    "type": "object",
    "required": [
        "instructedAmount",
        "debtorAccount",
        "creditorName",
        "creditorAccount",
        "creditorAddress",
        "serviceLevel",
        "chargeBearer"
    ],
    "properties": {
        "endToEndIdentification": {
            "type": "string",
            "maxLength": 35
        },
        "debtorAccount": {
            "$ref": "#\/definitions\/AccountReference"
        },
        "instructedAmount": {
            "$ref": "#\/definitions\/Amount"
        },
        "creditorAccount": {
            "$ref": "#\/definitions\/AccountReference"
        },
        "creditorAgent": {
            "type": "string",
            "default": "AAAADEBBXXX",
            "pattern": "[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}"
        },
        "creditorAgentName": {
            "type": "string",
            "description": "Mandatory, if no IBAN used for creditorAccount.",
            "maxLength": 70
        },
        "creditorAgentAddress": {
            "description": "Mandatory, if no IBAN used for creditorAccount.",
            "$ref": "#\/definitions\/Address"
        },
        "creditorName": {
            "type": "string",
            "description": "Creditor Name",
            "default": "Търговец ЕООД",
            "maxLength": 70
        },
        "creditorAddress": {
            "$ref": "#\/definitions\/Address"
        },
        "chargeBearer": {
            "$ref": "#\/definitions\/ChargeBearerCode"
        },
        "remittanceInformationUnstructured": {
            "type": "string",
            "default": "Ref Number Merchant",
            "maxLength": 140
        },
        "serviceLevel": {
            "$ref": "#\/definitions\/ServiceLevelCode",
            "example": "SPOT"
        }
    }
}

AccountReference

{
    "type": "object",
    "properties": {
        "iban": {
            "type": "string",
            "description": "IBAN of account, mandatory for debtorAccount for all payments and mandatory for creditorAccount when payment is: domestic-credit-transfers-bgn, domestic-budget-transfers-bgn, sepa-credit-transfers. Optional for creditorAccount when payment is cross-border-transfers. If no IBAN used then \"creditorAgentName\" and \"creditorAgentAddress\" have to be filled. For domestic-budget-transfers-bgn payment initiation, position 13 of creditorAccount IBAN must contain \"8\" or \"3\" only.",
            "pattern": "[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}",
            "default": "BG009STSA000001"
        }
    }
}

Href

{
    "type": "string",
    "properties": {
        "href": {
            "type": "string"
        }
    }
}

Search form

PIS API

PIS API 1.0.0

Paths

/payments/{payment-product}

/payments/{payment-product}/{paymentId}

/payments/{payment-product}/{paymentId}/status

Definitions