Платеж
Запрос создает платежную транзакцию.
Примеры платежей
- Обычные платежи
- Рекуррентные платежи
- Оплата по токену
- Одношаговый
- Двухшаговый
PUT /sites/site-01/payments/1234asdzxc
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
{
"paymentMethod": {
"type": "CARD",
"pan": 4929915007230906,
"expiryDate": "12/24",
"cvv2": "123"
},
"amount": {
"currency": "KZT",
"value": "100.00"
},
"comment": "Payment for testing.",
"flags": ["SALE"],
"customer": {
"account": "123456",
}
}
{
"paymentId": "1234asdzxc",
"createdDateTime": "2023-12-01T12:03:18.339+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"capturedAmount": {
"currency": "KZT",
"value": "0.00"
},
"refundedAmount": {
"currency": "KZT",
"value": "0.00"
},
"paymentMethod": {
"type": "CARD",
"maskedPan": "492991******0906"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2023-12-01T12:03:18.357+06:00"
},
"customer": {
"account": "123456"
},
"flags": ["SALE"],
}
PUT /sites/site-01/payments/1234asdzxc
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
{
"paymentMethod": {
"type": "CARD",
"pan": 4929915007230906,
"expiryDate": "12/24",
"cvv2": "123"
},
"amount": {
"currency": "KZT",
"value": "100.00"
},
"comment": "Payment for testing.",
"customer": {
"account": "123456",
}
}
{
"paymentId": "1234asdzxc",
"createdDateTime": "2023-12-01T12:03:18.339+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"capturedAmount": {
"currency": "KZT",
"value": "0.00"
},
"refundedAmount": {
"currency": "KZT",
"value": "0.00"
},
"paymentMethod": {
"type": "CARD",
"maskedPan": "492991******0906"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2023-12-01T12:03:18.357+06:00"
},
"customer": {
"account": "123456"
},
}
- Одношаговый
- Двухшаговый
- Последующий одношаговый
- Последующий двухшаговый
PUT /sites/site-01/payments/123asdzxc
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
{
"paymentMethod": {
"type": "CARD",
"pan": 4929915007230906,
"expiryDate": "12/24",
"cvv2": "123"
},
"amount": {
"currency": "KZT",
"value": "100.00"
},
"comment": "Payment for testing.",
"flags": ["SALE", "RECURRENT_FIRST"]
"customer": {
"account": "123456",
"email": "test@test.kz"
},
"recurrent": {
"minAuthDay": 30,
"expiryDate": "2023-12-31"
}
}
{
"paymentId": "123asdzxc",
"createdDateTime": "2023-12-01T12:03:35.782+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"capturedAmount": {
"currency": "KZT",
"value": "0.00"
},
"refundedAmount": {
"currency": "KZT",
"value": "0.00"
},
"paymentMethod": {
"type": "CARD",
"maskedPan": "524366******0066"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2023-12-01T12:03:35.805+06:00"
},
"customer": {
"account": "123456",
"email": "test@test.kz"
},
"flags": [
"SALE",
"RECURRENT_FIRST"
]
}
PUT /sites/site-01/payments/123asdzxc
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
{
"paymentMethod": {
"type": "CARD",
"pan": 4929915007230906,
"expiryDate": "12/24",
"cvv2": "123"
},
"amount": {
"currency": "KZT",
"value": "100.00"
},
"comment": "Payment for testing.",
"flags": [
"RECURRENT_FIRST"
],
"customer": {
"account": "123456",
"email": "test@test.kz"
},
"recurrent": {
"minAuthDay": 30,
"expiryDate": "2023-12-31"
}
}
{
"paymentId": "123asdzxc",
"createdDateTime": "2023-12-01T12:03:35.782+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"capturedAmount": {
"currency": "KZT",
"value": "0.00"
},
"refundedAmount": {
"currency": "KZT",
"value": "0.00"
},
"paymentMethod": {
"type": "CARD",
"maskedPan": "524366******0066"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2023-12-01T12:03:35.805+06:00"
},
"customer": {
"account": "123456",
"email": "test@test.kz"
},
"flags": [
"RECURRENT_FIRST"
]
}
PUT /sites/site-01/payments/123asdzxc
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
{
"paymentMethod": {
"type": "RECURRENT",
"firstPaymentId": "test_payment_01"
},
"amount": {
"currency": "KZT",
"value": "100.00"
},
"flags": [
"SALE"
],
"comment": "Payment for testing.",
"customer": {
"account": "123456",
"email": "test@test.kz"
}
}
{
"paymentId": "test_payment_01",
"createdDateTime": "2023-12-20T09:06:10.807+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"capturedAmount": {
"currency": "KZT",
"value": "0.00"
},
"refundedAmount": {
"currency": "KZT",
"value": "0.00"
},
"paymentMethod": {
"type": "CARD",
"maskedPan": "524366******0066"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2023-12-20T09:06:11.103+06:00"
},
"customer": {
"account": "123456",
"email": "test@test.kz"
},
"flags": ["SALE"]
}
PUT /sites/site-01/payments/123asdzxc
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
{
"paymentMethod": {
"type": "RECURRENT",
"firstPaymentId": "test_payment_01"
},
"amount": {
"currency": "KZT",
"value": "100.00"
},
"comment": "Payment for testing.",
"customer": {
"account": "123456",
"email": "test@test.kz"
},
"flags": []
}
{
"paymentId": "test_payment_01",
"createdDateTime": "2023-12-20T09:06:10.807+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"capturedAmount": {
"currency": "KZT",
"value": "0.00"
},
"refundedAmount": {
"currency": "KZT",
"value": "0.00"
},
"paymentMethod": {
"type": "CARD",
"maskedPan": "524366******0066"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2023-12-20T09:06:11.103+06:00"
},
"customer": {
"account": "123456",
"email": "test@test.kz"
},
"flags": []
}
- Одношаговый
- Двухшаговый
- Последующий одношаговый
- Последующий двухшаговый
PUT /sites/site-01/payments/123asdzxc
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
{
"paymentMethod": {
"type": "CARD",
"pan": 4929915007230906,
"expiryDate": "12/24",
"cvv2": "123"
},
"amount": {
"currency": "KZT",
"value": "100.00"
},
"comment": "Payment for testing.",
"flags": ["SALE", "BIND_PAYMENT_TOKEN"]
"customer": {
"account": "123456",
"email": "test@test.kz"
}
}
{
"paymentId": "123asdzxc",
"createdDateTime": "2023-12-01T12:03:35.782+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"capturedAmount": {
"currency": "KZT",
"value": "0.00"
},
"refundedAmount": {
"currency": "KZT",
"value": "0.00"
},
"paymentMethod": {
"type": "CARD",
"maskedPan": "524366******0066"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2023-12-01T12:03:35.805+06:00"
},
"customer": {
"account": "123456",
"email": "test@test.kz"
},
"flags": [
"SALE",
"BIND_PAYMENT_TOKEN"
],
"createdToken": {
"token": "a7228290-f4e3-49ab-9715-8ffd98035a19",
"name": "524366******0066"
}
}
PUT /sites/site-01/payments/123asdzxc
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
{
"paymentMethod": {
"type": "CARD",
"pan": 4929915007230906,
"expiryDate": "12/24",
"cvv2": "123"
},
"amount": {
"currency": "KZT",
"value": "100.00"
},
"comment": "Payment for testing.",
"flags": [
"BIND_PAYMENT_TOKEN"
],
"customer": {
"account": "123456",
"email": "test@test.kz"
}
}
{
"paymentId": "123asdzxc",
"createdDateTime": "2023-12-01T12:03:35.782+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"capturedAmount": {
"currency": "KZT",
"value": "0.00"
},
"refundedAmount": {
"currency": "KZT",
"value": "0.00"
},
"paymentMethod": {
"type": "CARD",
"maskedPan": "524366******0066"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2023-12-01T12:03:35.805+06:00"
},
"customer": {
"account": "123456",
"email": "test@test.kz"
},
"flags": [
"BIND_PAYMENT_TOKEN"
],
"createdToken": {
"token": "a7228290-f4e3-49ab-9715-8ffd98035a19",
"name": "524366******0066"
}
}
PUT /sites/site-01/payments/123asdzxc
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
{
"paymentMethod": {
"type": "TOKEN",
"paymentToken": "a7228290-f4e3-49ab-9715-8ffd98035a19"
},
"amount": {
"currency": "KZT",
"value": "100.00"
},
"flags": [
"SALE"
],
"comment": "Payment for testing.",
"customer": {
"account": "123456",
"email": "test@test.kz"
}
}
{
"paymentId": "test_payment_01",
"createdDateTime": "2023-12-20T09:06:10.807+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"capturedAmount": {
"currency": "KZT",
"value": "0.00"
},
"refundedAmount": {
"currency": "KZT",
"value": "0.00"
},
"paymentMethod": {
"type": "TOKEN"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2023-12-20T09:06:11.103+06:00"
},
"customer": {
"account": "123456",
"email": "test@test.kz"
},
"flags": [
"SALE"
]
}
PUT /sites/site-01/payments/123asdzxc
Accept: application/json
Authorization: Bearer 5628af1c-26d9-42e7-8a6a-c22d491d79fb
Content-type: application/json
{
"paymentMethod": {
"type": "TOKEN",
"paymentToken": "a7228290-f4e3-49ab-9715-8ffd98035a19"
},
"amount": {
"currency": "KZT",
"value": "100.00"
},
"comment": "Payment for testing.",
"customer": {
"account": "123456",
"email": "test@test.kz"
}
}
{
"paymentId": "test_payment_01",
"createdDateTime": "2023-12-20T09:06:10.807+06:00",
"amount": {
"currency": "KZT",
"value": "100.00"
},
"capturedAmount": {
"currency": "KZT",
"value": "0.00"
},
"refundedAmount": {
"currency": "KZT",
"value": "0.00"
},
"paymentMethod": {
"type": "TOKEN"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2023-12-20T09:06:11.103+06:00"
},
"customer": {
"account": "123456",
"email": "test@test.kz"
},
"flags": []
}
Параметры запроса
Path Parameters
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
siteId | string | Да | Строковый идентификатор сайта ТСП в QIWI Кассе. |
paymentId | string | Да | Уникальный идентификатор платежа в информационной системе ТСП. Уникальность означает, что идентификатор должен отличаться от идентификаторов всех ранее созданных платежей ТСП в рамках одного siteId. |
Headers
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
Authorization | string | Да | Авторизационные данные. "Bearer [acсess-token]" |
Content-type | string | Да | Тип запроса. "application/json" |
Accept | string | Да | Тип запроса. "application/json" |
Request
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
paymentMethod | object | Да | Метод платежа. |
amount | object | Да | Данные о сумме операций |
comment | string | Нет | Коментарий к операций |
flags | array of strings | Да | Дополнительные команды для API. "SALE" — одношаговый платеж. "BIND_PAYMENT_TOKEN" — флаг для выпуска платежного токена. "RECURRENT_FIRST" — флаг для инициации первого рекуррентного платежа. |
customer | object | Нет | Данные о Покупателе. |
billId | string | Нет | Уникальный номер заказа в системе ТСП, к которому относится платеж. Номер создается в системе ТСП или генерируется автоматически на стороне QIWI, если не указан в запросе. |
recurrent | object | Нет | Данные первого рекуррентного платежа. Обязателен, если флаг RECURRENT_FIRST |
PaymentMethod
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
type | string | Да | Метод значения платежа. CARD - оплата по карте. TOKEN - оплата по платежному токену. RECURRENT - оплата рекуррентного платежа |
pan | string | Нет | PAN карты. Обязателен для type=CARD |
expiryDate | string | Нет | Дата истечения срока действия (формат MM/YY). Обязателен для type=CARD |
cvv2 | string | Нет | CVV2/CVC2 на банковской карте. Только для type=CARD |
paymentToken | string | Нет | Токен карты. При оплате с помощью платежных токен. Обязателен для type=TOKEN |
firstPaymentId | string | Нет | Идентификатор первого платежа. Обязателен для type=RECURRENT |
Amount
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
value | number | Да | Сумма операции (округленная до двух десятичных знаков в меньшую сторону). |
currency | string(3) | Да | Валюта в буквенном формате согласно ISO 4217. |
Response
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
paymentId | string | Да | Уникальный идентификатор платежа в информационной системе ТСП. Уникальность означает, что идентификатор должен отличаться от идентификаторов всех ранее созданных платежей ТСП в рамках одного siteId. |
createdDateTime | string | Да | Дата создания платежа в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:mm). |
amount | object | Да | Информация о сумме операций |
capturedAmount | object | Да | Информация о сумме подтверждений. |
refundedAmount | object | Да | Информация о сумме возврата. |
paymentMethod | object | Да | Метод платежа |
status | object | Да | Статус платежа |
customer | object | Нет | Информация о клиенте |
flags | array of strings | Да | Дополнительные команды для API. "SALE" — одношаговый платеж. "BIND_PAYMENT_TOKEN" — флаг для выпуска платежного токена. "RECURRENT_FIRST" — флаг для инициации первого рекуррентного платежа. |
createdToken | object | Нет | Данные о созданном токене. |
requirements | object | Нет | Требования для дополнительной аутентификации клиента |
Customer
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
account | string | Нет | Уникальный идентификатор клиента. Обязательный, если флаг BIND_PAYMENT_TOKEN |
email | string | Нет | Email клиента в системе ТСП |
name | string | Нет | Наименование клиента |
phone | string | Нет | Номер мобильного телефона. Например: 77071112233 |
Status
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
value | string | Да | Строковое значение статуса. WAITING - ожидание платежа. DECLINED - ошибка в платеже. COMPLETED - успешность платежа. |
changedDateTime | string | Да | Дата изменения платежа в формате ISO8601 (YYYY-MM-DDThh:mm:ss±hh:mm). |
reason | string | Нет | Строковое описание ошибки платежа. |
CreatedToken
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
token | string | Да | Строковое значение токена. |
name | string | Да | Название токена |
Requirements
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
threeDS | object | Да | Данные для аутентификации банковских карт по протоколам 3DS и 3DS2.0 |
ThreeDS
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
pareq | string | Да | Аутентификационное сообщение для передачи в ACS банка-эмитента через браузер клиента |
acsUrl | string | Да | URL ACS сервера банка-эмитента, куда следует перенаправить клиента |
Recurrent
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
minAuthDay | int | Да | Минимальное количество дней авторизации, периодичность списания в днях |
expiryDate | string | Да | Дата до которой будут выполняться рекуррентные платежи |