Skip to content

PAYMENT Notification Format

Headers

  • Signature: XXX
  • Accept: application/json
  • Content-type: application/json

Body Parameters

Parameter Description Type When present
type Notification type — only PAYMENT string Always
version Notification version string Always
payment Payment description object Always

payment

Parameter Description Type When present
type Operation type — only PAYMENT string(200) Always
paymentId Payment identifier in the merchant’s system string(200) Always
createdDateTime Operation date and time URL-encoded string
YYYY-MM-DDThh:mm:ssZ
Always
billId Identifier of the invoice corresponding to the operation string(200) Always
qrCodeUid QR code issue operation identifier in merchant’s system string In case of operation with Faster Payment System
amount Operation amount object Always
status Operation status object Always
paymentMethod Payment method object Always
paymentCardInfo Payment card information object Always
credentialOnFile Saved card information object When tokenized card is used in the payment
merchantSiteUid Merchant’s site identifier String Always
customer Customer information object Always
customFields Additional information that supplements the operation data object Always
flags Additional API commands Array. Possible elements: SALE, REVERSAL Always
tokenData Object with information on payment token object When payment token issue was requested
settlementAmount Merchant’s settlement amount object If payment currency and merchant settlement currency are different

amount

Parameter Description Type When present
value Operation amount, rounded down to two decimal places Number(6.2) Always
currency Currency code according to ISO 4217 string(3) Always

status

Parameter Description Type When present
value Notification status string Always
changedDateTime Notification status change date and time URL-encoded string
YYYY-MM-DDThh:mm:ssZ
Always
reasonCode Rejection reason code string(200) If the operation was rejected
reasonMessage Rejection reason description string(200) If the operation was rejected
errorCode Error code Number In case of errors
psErrorCode Payment system error code string If the operation was rejected

paymentMethod

Parameter Description Type When present
type Payment method type string Always
paymentToken Payment token string For payments using a payment token
maskedPan Masked PAN string For payments using a payment token or card
rrn Payment RRN (ISO 8583) number For payments using a payment token or card
authCode Auth-code for the payment number For payments using a payment token or card
phone Phone number linked to the customer’s card string When paying via Fast Payments System

paymentCardInfo

Parameter Description Type
issuingCountry Country code of the issuing bank string(3)
issuingBank Issuing bank string
paymentSystem Payment system type string
fundingSource Card type (debit/credit/…) string
paymentSystemProduct Card category string

credentialOnFile

Parameter Description Type When present
type Payment operation type string When tokenized card is used in the payment
trn Identifier of the transaction when card was saved string When tokenized card is used in the payment

customer

Parameter Description Type When present
phone Customer’s phone string Always
email Customer’s e-mail string Always
account Customer’s identifier in the merchant’s system string Always
ip Customer’s IP address string Always
country Customer’s country from address string string Always
bic BIC of the bank that issues the card string Only for FPS payments
lastName Customer’s last name string Only for FPS payments
firstName Customer’s name string Only for FPS payments
middleName Customer’s patronymic string Only for FPS payments
simpleAddress Customer’s address string Only for FPS payments
inn Customer’s TIN string Only for FPS payments
bankMemberId Customer’s bank identifier string Only for FPS payments

customFields

Parameter Description Type When present
cf1 Additional information that supplements the operation data string(256) Always
cf2 Additional information that supplements the operation data string(256) Always
cf3 Additional information that supplements the operation data string(256) Always
cf4 Additional information that supplements the operation data string(256) Always
cf5 Additional information that supplements the operation data string(256) Always

tokenData

Parameter Description Type When present
paymentToken Payment token string string When payment token issue was requested
expiredDate Payment token expiration date string When payment token issue was requested

settlementAmount

Parameter Description Type When present
value Settlement amount, rounded down to two decimal places number(6.2) If payment currency and merchant settlement currency are different
currency Currency code according to ISO 4217 string(3) If payment currency and merchant settlement currency are different

Notification Body Example

PAYMENT notification body example
{
  "payment": {
    "paymentId": "A22170834426031500000733E625FCB3",
    "customFields": {},
    "type": "PAYMENT",
    "createdDateTime": "2022-08-05T11:34:42+03:00",
    "status": {
      "value": "SUCCESS",
      "changedDateTime": "2022-08-05T11:34:44+03:00"
    },
    "amount": {
      "value": 5.00,
      "currency": "RUB"
    },
    "paymentMethod": {
      "type": "SBP",
      "phone": "79111112233"
    },
    "merchantSiteUid": "test-00",
    "customer": {
      "phone": "0",
      "bankAccountNumber": "4081710809561219555",
      "bic": "044525974",
      "lastName": "ИВАНОВ",
      "firstName": "ИВАН",
      "middleName": "ИВАНОВИЧ",
      "simpleAddress": "",
      "bankMemberId": "100000000008"
    },
    "billId": "autogenerated-6cd20922-b1d0-4e67-ba61-e2b7310c4006",
    "flags": [
      "SALE"
    ],
    "qrCodeUid": "acfd9"
  },
  "type": "PAYMENT",
  "version": "1"
}