Работа с платежами

Данное API позволяет работать с платежами

Платежи

Получить ссылку на виджет

Данный запрос необходим для создания уникальной ссылки на ваш продукт и получения ссылки на init платежа

POST   /api/v1/widget
Host: http://4pay.online
Content-Type: application/json
Authorization: Bearer 6d3d2541-6f9a-4fb6-985f-9f5bcec8a4ce
Content-Type: text/plain

Поля запроса:

Поле	Значение	Тип	Обязательность
payment		Обьект
>amount	Сумма транзакции	Число
>type	Описание типа платежа (по умолчанию widget)	Строка
>description	Описание платежа	Строка
> txid	Идентификатор	Строка
>money_storage		Объект
>>add	Параметр, отвечающий за сохранение карты (по умолчанию true)	Boolean
>>customer	Идентификатор транзакции в системе мерчанта	Строка
Символ ">" обозначает глубину вложенности

json

{
"payment": {
        "amount": 1000,
        "type": "widget",
        "description": "Сплит платёж",
        "txid": "00000000",
        "money_storage":{
         "add": true,
         "customer" : "lucky"
        }
    }
}

Пример ответа:

json

{
    "data": {
        "amount": 1000,
        "description": "Сплит платёж",
        "finished": null,
        "id": 360,
        "provider": "bank131",
        "providertxid": "ps_332051",
        "public_token": "0213mn213kl123lnnjk1nknjvdNJJKNNDEjn",
        "started": "2020-05-22T09:23:07",
        "status": "created",
        "txid": "2347",
        "url": "https://4pay.online/prod_widget/?token=0213mn213kl123lnnjk1nknjvdNJJKNNDEjn"
    }
}

Поле	Значение	Тип
data		Обьект
>amount	Сумма транзакции	Число
>description	Описание платежа	Строка
> finished	Время завершения транзакции	Строка
> id	Идентификатор транзакции в нашей системе	Строка
> provider	Идентификатор провайдера	Строка
> providertxid	Идентификатор в системе провайдера	Строка
> public_token	Токен, с помощью которого можно открыть ссылку	Строка
> started		Строка
> txid	Идентификатор в системе партнера	Строка
> url		Строка

Символ ">" обозначает глубину вложенности

Оплатить по привязанной карте

Позволяет совершать оплату по расписанию с сохраненной ранее карты

POST   /api/v1/payments
Host: http://4pay.online
Content-Type: application/json
Authorization: Bearer 6d3d2541-6f9a-4fb6-985f-9f5bcec8a4ce
Content-Type: text/plain

json

{
"payment": {
        "amount": 1000,
        "type": "widget",
        "description": "Сплит платёж",
        "txid": "00000000",
        "money_storage":{
         "card_uid": "jk2njklJnkjbnHbkjNbN2312J",
         "add": true,
         "customer" : "lucky"
        }
    }
}

Поля запроса:

Поле	Значение	Тип	Обязательность
payment		Обьект
>amount	Сумма транзакции	Число
>type	Описание типа платежа (по умолчанию widget)	Строка
>description	Описание платежа	Строка
> txid	Идентификатор в системе партнера	Строка
>money_storage		Объект
>>card_uid	Идентификатор привязанной карточки	Строка
>>add	Параметр, отвечающий за сохранение карты (по умолчанию true)	Boolean
>>customer	Идентификатор транзакции в системе мерчанта	Строка
Символ ">" обозначает глубину вложенности

Получаемый ответ идентичен тому, который возвращался в запросе на оплату

Получить список платежей

Возвращает список платежей мерчанта

GET   /api/v1/payments
Host: http://4pay.online
Content-Type: application/json
Authorization: Bearer 6d3d2541-6f9a-4fb6-985f-9f5bcec8a4ce
Content-Type: text/plain

Пример ответа:

json

{
    "data": [
            {
                "amount": 30000,
                "description": "Описание платежа",
                "finished": null,
                "id": 357,
                "provider": "themap",
                "providertxid": null,
                "started": "2020-05-22T08:57:52",
                "status": "failed",
                "txid": "Уникальный идентификатор транзакции"
            },
            {
                "amount": 1200,
                "description": "Villages",
                "finished": null,
                "id": 258,
                "provider": "themap",
                "providertxid": null,
                "started": "2020-05-13T14:43:45",
                "status": "created",
                "txid": "dekq221jw-3dfe-46fa-4543-kdf2ewipuNJKNne12"
            }
    ]
}

Поле	Значение	Тип
data		Обьект
>amount	Сумма транзакции	Число
>description	Описание платежа	Строка
> finished	Время завершения транзакции	Строка
> id	Идентификатор транзакции в нашей системе	Строка
> provider	Идентификатор транзакции в нашей системе	Строка
> providertxid	Идентификатор в системе провайдера	Строка
> started		Строка
> txid	Идентификатор в системе партнера	Строка

Получить статус платежа

Позволяет узнать статус конкретного платежа

GET /api/v1/payments/:id
Host: http://4pay.online
Content-Type: application/json
Authorization: Bearer 6d3d2541-6f9a-4fb6-985f-9f5bcec8a4ce
Content-Type: text/plain

Ответ будет идентичен предыдущему, но будет состоять из одного объекта.

Сделать возврат

Осуществление возврата за товар. Параметр "amount" обязательный, в связи с предусмотренной возможностью частичного возврата средств, если оное подразумевает бизнес-логика В случае осуществления возврата по транзакции, ей присвается статус "refunded"

PUT   /api/v1/payments/:id
Host: http://4pay.online
Content-Type: application/json
Authorization: Bearer 6d3d2541-6f9a-4fb6-985f-9f5bcec8a4ce
Content-Type: text/plain

json

{
    "payment": 
            {
                "amount": 30000
            }
}

Поля запроса:

Поле	Значение	Тип
payment		Обьект
>amount	Сумма транзакции	Число

Ответ будет идентичен ответу из запроса "Получить статус платежа", но статус платежа будет refund", а сумма будет равняться исходной сумме- значение из поля "amount"