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

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7

Метод для отримання основної інформації про платіж.

URI

POST 

Запит:

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



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

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

data



externalIdId платежу у зовнішній системіstringякщо немає  id"xyz123"
idId платежу в системі UAPAYstring, uuidякщо немає externalId"f22b8709-18c9-40e1-a4fa-77aa5b524fc6"


Приклад запиту по id платежу
{
    "params": {
        "sessionId": "52be10d0-d094-4ede-b201-904783df5f8d",
        "id": "f22b8709-18c9-40e1-a4fa-77aa5b524fc6"
    }
}


Приклад запиту по зовнішньому id платежу
{
    "params": {
        "sessionId": "52be10d0-d094-4ede-b201-904783df5f8d",
        "externalId": "xyz123"
    }
}

Відповідь:

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

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

integer

1

data




id

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

string, uuid

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

externalId

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

string

"xyz123"

paymentNumberПослідовний номер платежуstring, integer"210"
statusСтатус операціїstring

Можливі варіанти статусів:

'PENDING' - операція знаходиться в процесі обробки, необхідно віконати повторний запит статусу
'NEEDS_CONFIRMATION' - операція чекае підтвердження методом Підтвердження платежу (Confirm Charge Card)
'FINISHED' - успішна операція
'REJECTED' - операція відхилена

amountСума платежу в копійкахinteger50000
createdDateДата створення платежу

string

"Wed, 14 Jun 2017 15:52:01 +0300"
processedDateДата обробки платежуstring"Wed, 14 Jun 2017 15:52:01 +0300"
reason.codeКод помилки операціїstring"LIMIT_EXCEEDED"

reason.message

Повідомлення помилки операціїstring"Operations Limit"
reason.responseCodeКод відповіді помилки операції (від банку)string"082"


Приклад відповіді успішної операції
{
    "status": 1,
    "data": {
        "id": "004ce685-4948-407a-a11a-57151e8d1bd7",
        "externalId": "xyz123",
        "paymentNumber": "210",
        "status": "FINISHED",
        "amount": 50000,
        "createdDate": "Wed, 14 Jun 2017 13:09:02 +0300",
        "processedDate": "Wed, 14 Jun 2017 13:09:03 +0300"
    }
}


Приклад відповіді операції з помилкою
{
    "status": 1,
    "data": {
        "id": "004ce685-4948-407a-a11a-57151e8d1bd7",
        "externalId": "xyz123",
        "paymentNumber": "210",
        "status": "REJECTED",
        "amount": 50000,
        "createdDate": "Wed, 14 Jun 2017 15:43:46 +0300",
        "processedDate": "Wed, 14 Jun 2017 15:43:47 +0300",
        "reason": {
            "code": "LIMIT_EXCEEDED",
            "message": "Operations Limit",
		    "pluginId": "5",
            "responseCode": "082",
			"source": "ALFA_A2P"
        }
    }
  • No labels