Method for showing the status of the current invoice payment
Tip | |
---|---|
icon | false | title | URIPOST api/invoicer/payments/checkStatus |
...
Request:
Key |
---|
Description |
---|
Type |
---|
Mandatory |
---|
Example | ||||
---|---|---|---|---|
params | ||||
sessionId |
client session id | string, uuid |
yes | "000ab70b-ef76-4385-a0f5-a98693c716f1" |
paymentId | payment id |
string, uuid |
yes | "08eff720-9432-4951-a698-94e24db59e66" |
invoiceId | invoice id |
string, uuid |
yes | "f9f57a53-fe87-465d-8f7a-795251a6ba46" |
Example of a query
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "params": { "sessionId": "613f7045-03a2-4bbb-8ff8-e2202e71d41f", "paymentId": "02984d64-12d2-45d9-8329-f5ff92169e38", "invoiceId": "f9f57a53-fe87-465d-8f7a-795251a6ba46" } } |
Відповідь:
Key |
---|
Description |
---|
Type |
---|
Example |
---|
status |
Status. 0 - |
error, 1 - |
success | integer | 1 | |
data | |||
id |
operations | string, uuid |
| ||
pluginId | bank id |
integer | 2 | |
amount |
payment amount | integer | 100 |
status |
invoice payment status | string | "NEEDS_CONFIRMATION" | |
confirmation | object | ||
confirmation.{}.type |
type of payment card | string |
| ||
confirmation.{}.confirmationsLeft |
confirmation attempts | integer |
| ||
confirmation.{}.url |
processing page address | string |
| ||
confirmation.{}.form.PaReq |
authorization data on the processing page | string | |
confirmation.{}.redirect.url |
redirect address from the processing page | string |
| ||
confirmation.{}.redirect.params.id |
payment ID parameter | ||
paymentStatus |
payment status from the invoice system | string | "NEW" |
Example of an answer for LOOKUP card
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "status": 1, "data": { "id": "02984d64-12d2-45d9-8329-f5ff92169e38", "status": "NEEDS_CONFIRMATION", "amount": 100, "pluginId": 2, "confirmation": { "type": "LOOKUP", "confirmationsLeft": 3 }, "paymentStatus": "NEW" } } |
Example of an answer for 3DS card
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{ "status": 1, "data": { "id": "baa27404-b440-4698-859a-cf9e328c8589", "status": "NEEDS_CONFIRMATION", "amount": 3000, "pluginId": 1, "key": "Fb64oESWzABBCf9fjbBsPKJyhxFfW7V6xCATquk3R46P.jp45ehf1105021748214", "confirmation": { "type": "3DS", "url": "https://3ds.ukrsotsbank.com:443/way4acs/pa?id=XAFO8XZ_Fa-UpxbzASJniw", "form": { "PaReq": "eJxVUtFu2zAMfM5fGP0AS7JjWwlUAVmDrcHm1ugcDNnLYChE425RXMne0nx9STkpMgGCSd6JNI9U9c4BLL+DGRxoVYL3zTNE7fb2plo8wesvkU3TTM5yURRS3uiJCmE9mai/4Hx7sFrEPE4Uu7iIdI3VWVZIwQuR5DzPklQqRlEES3Bm19ge7YlqzOun1YPOkhwrKHZ2CdmDWy01H08yfpAxholgmz3oGnwfXTJGdeO/tfZ3pFgAiWUOg+3dm5Z8qtjFIWBwf/Su77s5YyIpsAUei3mKh5XVij2B7w7WQ+UOBiVp7XP84jvF6BU+ZldNqGog24/1ju1Wl/Wal6f19LHeHB9OZvq4XPwrx3urGDGIuW160AkXUoiURyKfZ+k8LRQL8aDNnn5Xp2k84yjN6BHQUcHFBSXwOhK6HpwDa970TCL64REER2wMkIcj+7Cppas21N39eTqmR7UXm/zHz+Xdutl1Q3WSL+JrvdmvMv7l872hmQXSOXeL8ooZlyF5G7RWjNJhgbA4pF3YMbT+2713DWnAvQ==" } }, "redirect": { "url": "https://api.zero.uapay.ua/api/payments/ecom/confirm", "params": { "id": "baa27404-b440-4698-859a-cf9e328c8589" } }, "paymentStatus": "NEW" } } |
...