Retrieving a List of Invoice Payments¶
Gets payment status of the invoice. Response contains the list of payments data with the given billId.
Request¶
GET /payin/v1/sites/{siteId}/bills/{billId}
Path Parameters¶
| Parameter | Required | Type | Description |
|---|---|---|---|
| siteId | Yes | string | Merchant site identifier |
| billId | Yes | string | Unique invoice identifier in the Merchant’s system |
Headers¶
| Header | Required | Type | Description |
|---|---|---|---|
| Authorization | Yes | string | API access key. Bearer [access-token] |
| Accept | No | string | Response content. application/json |
Request Example¶
Retrieving a List of Invoice Payments
GET /partner/payin/v1/sites/site-01/bills/3a3d0286cefe645d2b00 HTTP/1.1
Accept: application/json
Authorization: Bearer 5c4b25xx93aa435d9cb8cd17480356f9
Content-type: application/json
Host: b2b-api.qiwi.com
Response¶
See also HTTP error codes
Successful Response Parameters¶
A list of payments for an invoice with the billId from the request is transmitted as an array that contains oblects with parameters described in the table
| Parameter | Required | Type | Description |
|---|---|---|---|
| paymentId | Yes | string | Payment identifier |
| billId | Yes | string | Requested invoice identifier |
| createdDateTime | Yes | string | Payment creation date |
| amount | Yes | object | Operation amount |
| capturedAmount | Yes | object | Captured amount |
| refundedAmount | Yes | object | Refunded amount |
| paymentMethod | Yes | object | Payment method |
| status | Yes | string | Invoice status |
| paymentCardInfo | Yes | object | Information on the card that was used for payment |
| createdToken | No | object | Payment token information |
| customer | No | object | Customer data: account, email, phone |
| comment | No | string | Service description for the custome |
| customFields | No | object | Additional information for the operation |
Error Parameters¶
| Parameter | Required | Type | Description |
|---|---|---|---|
| serviceName | Yes | string | Name of the service that produced the error |
| errorCode | Yes | string | Error code |
| description | Yes | string | Error description for the merchant |
| userMessage | Yes | string | Error description for the customer |
| dateTime | Yes | string | Error date and time |
| traceId | Yes | string | Error Log unique ID |
Response Examples¶
{
"billId": "3a3d0286cefe645d2b11",
"invoiceUid": "235d8d5a-38ed-11fc-9ab6-8b5a65d7e2f8",
"amount": {
"currency": "RUB",
"value": "3000.00"
},
"expirationDateTime": "2023-05-07T19:25:36+03:00",
"status": {
"value": "PAID",
"changedDateTime": "2023-04-07T19:28:12+03:00"
},
"comment": "Детская футбольная школа «Тигры»",
"flags": [
"SALE"
],
"payUrl": "https://payment.qiwi.com/form?invoiceUid=235d8d5a-11ed-46fc-9ab6-8b5a65d7e2f8",
"payments": [
{
"paymentId": "cd4a4ade-011e6-484d-87c8-40a7f48326fa",
"billId": "3a3d0286cefe645d2b11",
"createdDateTime": "2023-04-07T19:27:52+03:00",
"amount": {
"currency": "RUB",
"value": "3000.00"
},
"capturedAmount": {
"currency": "RUB",
"value": "3000.00"
},
"refundedAmount": {
"currency": "RUB",
"value": "0.00"
},
"paymentMethod": {
"type": "CARD",
"maskedPan": "422264******1232",
"rrn": "309711196151",
"authCode": "231181"
},
"status": {
"value": "COMPLETED",
"changedDateTime": "2023-04-07T19:28:12+03:00"
},
"comment": "Детская футбольная школа «Тигры»",
"customFields": {
"auto_capture": "true",
"invoice_creation_type": "PUBLIC_KEY"
},
"paymentCardInfo": {
"issuingCountry": "643",
"issuingBank": "Сбербанк России",
"paymentSystem": "VISA",
"fundingSource": "DEBIT",
"paymentSystemProduct": "N1|Visa Rewards"
}
},
{
"paymentId": "A30971626215731E01110841111138B2",
"billId": "3a3d0286cefe645d2b11",
"createdDateTime": "2023-04-07T19:26:21+03:00",
"amount": {
"currency": "RUB",
"value": "3000.00"
},
"capturedAmount": {
"currency": "RUB",
"value": "3000.00"
},
"refundedAmount": {
"currency": "RUB",
"value": "0.00"
},
"paymentMethod": {
"type": "SBP",
"phone": "0079031232001"
},
"status": {
"value": "DECLINED",
"changedDateTime": "2023-04-07T19:26:23+03:00",
"reason": "GATEWAY_INTEGRATION_ERROR",
"reasonMessage": "I07999 OPKC_TECH_ERROR"
},
"comment": "Детская футбольная школа «Тигры»",
"customFields": {
"auto_capture": "true",
"invoice_creation_type": "PUBLIC_KEY"
}
}
]
}