UAPAY - національний платіжний сервіс

Отримання даних по масиву платежів ECom (Show Payment list)

Метод для отримання основної інформації по масиву платіжів. В одному запиті може міститися не більше 100 (сто) платежів.

URI

POST /api/payments/ecom/show/list

Запит:

Ключ
Опис
Тип
Чи обов'язковий параметр?
Приклад
params



sessionIdid сесії клієнтаstring, uuidтак

"52be10d0-d094-4ede-b201-904783df5f8d"

data



externalIdsмасив Id у зовнішній системімасив stringякщо немає  id

["73737fa2-7130-8366-ab17-65ebbb359821",
"ce0c225b-b142-0ad0-3802-172b7598ea55"]

idsмасив  Id платежу в системі UAPAYмасив string, uuidякщо немає externalId["000c6d12-0d2e-4402-bf62-c474c92fc842",
"9251607b-e652-4d11-8f3c-91fc4b2b1427"]


Приклад запиту по id платежу
{  
   "params":{  
      "sessionId":"9499b6f1-907c-4907-93bf-5d89bda6c40a",
      "ids":[  
         "000c6d12-0d2e-4402-bf62-c474c92fc842",
         "9251607b-e652-4d11-8f3c-91fc4b2b1427"
      ]
   }
}


Приклад запиту по зовнішньому id платежу
{  
   "params":{  
      "sessionId":"9499b6f1-907c-4907-93bf-5d89bda6c40a",
      "externalIds":[  
         "73737fa2-7130-8366-ab17-65ebbb359821",
         "ce0c225b-b142-0ad0-3802-172b7598ea55"
      ]
   }
}

Відповідь:

Ключ
Опис
Тип
Приклад
status

Статус. 0 - помилка, 1 - успіх

integer

1

data




id

id операції в нашій системі

string, uuid

"004ce685-4948-407a-a11a-57151e8d1bd7"

externalId

id операції у зовнішній системі

string

"xyz123"

statusСтатус операціїstringзначения: "FINISHED", "REJECTED"
amountСума платежу в копійкахinteger50000
reason.codeКод помилки операціїstring"LIMIT_EXCEEDED"

reason.message

Повідомлення помилки операції (від банку)string"Operations Limit"
reason.responseCodeКод відповіді помилки операції (від банку)string"082"
error.codeКод відповіді в системі UAPAYstring"1001"
error.messageПовідомлення помилки операції в системі UAPAYstring"An error occurred. Please try again or contact the support service 0 800 21 44 64."


Приклад відповіді
{
    "status": 1,
    "data": {
        "payments": [
            {
                "id": "000c6d12-0d2e-4402-bf62-c474c92fc842",
                "externalId": "73737fa2-7130-8366-ab17-65ebbb359821",
                "status": "FINISHED",
                "amount": 14200,
                "pluginId": 1
            },
            {
                "id": "9251607b-e652-4d11-8f3c-91fc4b2b1427",
                "externalId": "ce0c225b-b142-0ad0-3802-172b7598ea55",
                "status": "REJECTED",
                "amount": 11100,
                "pluginId": 1,
                "reason": {
                    "code": "EXPIRED",
                    "message": "Expired",
                    "fields": {
                        "params": {
                            "key": "EXPIRED"
                        }
                    }
                },
                "error": {
                    "code": "1001",
                    "message": "An error occurred. Please try again or contact the support service 0 800 21 44 64."
                }
            }
        ]
    }
}


UAPAY - національний платіжний сервіс
pay@uapay.ua