Методы

Тестовый метод

Для проверки взаимодействия с API можно использовать тестовый метод.

Адрес метода

https://api.gbpayments.io/test

Параметр	Тип	Обязательный	Описание
success	int	Нет	Результат выполнения Если отправить 0 - вернет неуспешное выполнение метода с причиной
error	int	Нет	Код ошибки, которую нужно вернуть

Оплата по токену

Метод для оплаты по токену полученного из объекта card через PAY уведомление.

Адрес метода двухстадийной схемы

https://api.gbpayments.io/payment/token/auth

Адрес метода одностадийной схемы

https://api.gbpayments.io/payment/token/charge

Параметры

Параметр	Тип	Обязательный	Описание
token	string	Да	Полученный токен
amount	int	Да	Сумма платежа в копейках
currency	string	Да	Код валюты: RUB
description	string	Да	Назначение платежа
email	string	Да	E-mail плательщика, куда будет отправлена квитанция
order_id	string	Нет	Идентификатор заказа в системе продавца
account_id	string	Нет	Идентификатор плательщика в системе продавца
ip	string	Нет	IP-адрес плательщика

Пример ошибки

{
    "error": {
        "code":      10002,
        "text":      "Invalid parameter `token`",
        "error_id":  1002,
        "timestamp": 1597852096.013394,
        "name":      "token"
    }
}

Пример успешной операции

{
    "response": {
        "success":        1,
        "timestamp":      1491279174.7654,
        "transaction_id": 995
    }
}

Пример неуспешной операции

{
    "response": {
        "success":   0,
        "timestamp": 1491279174.7654,
        "reason":    "Недостаточно средств"
    }
}

Подтверждение оплаты

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

Адрес метода

https://api.gbpayments.io/payment/confirm

Параметры

Параметр	Тип	Обязательный	Описание
transaction_id	int	Да	Номер транзакции в системе
amount	int	Да	Сумма подтверждения в копейках в валюте операции

Пример запроса

{ "transaction_id": 590, "amount": 100 }

Пример успешного ответа

{
    "response": {
        "success":   1,
        "timestamp": 1491279174.7654
    }
}

Пример неуспешного ответа

{
    "response": {
        "success":   0,
        "timestamp": 1491279174.7654,
        "reason":    "Some reason"
    }
}

Отмена оплаты

Отмена доступна только для неподтвержденных платежей проведенных по двухстадийной схеме. Отмена подразумевает немедленный возврат (разблокировку) средств пользователю.

Отмену оплаты можно выполнить через личный кабинет либо через вызов метода API.

Адрес метода

https://api.gbpayments.io/payment/cancel

Параметры

Параметр	Тип	Обязательный	Описание
transaction_id	int	Да	Номер транзакции в системе

Пример запроса

{ "transaction_id": 590 }

Пример успешного ответа

{
    "response": {
        "success":   1,
        "timestamp": 1491279174.7654
    }
}

Возврат средств

Возврат можно осуществить только по подтвержденным платежам проведенным по любой схеме. Сроки возврата средств пользователю зависят от его банка-эмитента, но обычно это занимает от 3х до 10 рабочих дней.

Возврат денег можно выполнить через личный кабинет, либо через вызов метода API.

Адрес метода

https://api.gbpayments.io/payment/refund

Параметры

Параметр	Тип	Обязательный	Описание
transaction_id	int	Да	Номер транзакции оплаты
amount	int	Да	Сумма возврата в копейках в валюте операции

Пример запроса

{ "transaction_id": 900, "amount": 100 }

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

{
    "response": {
        "success":        1,
        "timestamp":      1491279174.7654,
        "transaction_id": 901 // Идентификатор операции возврата
    }
}

Получение транзакций

Возвращает список транзакций для текущего сайта.

Адрес метода

https://api.gbpayments.io/payment/list

Параметры

Параметр	Тип	Обязательный	Описание
date_start	string	Нет	Дата/время с какого числа необходимо отобразить транзакции. Если не указано, по умолчанию будут выгружены транзакции от 1 числа текущего месяца. Формат YYYY-MM-DD [HH:II]
date_end	string	Нет	Дата/время до какого числа необходимо отобразить транзакции. Формат YYYY-MM-DD [HH:II]
type	int	Нет	Тип транзакции: 1 - оплата картой, 2 - оплата токеном, 3 - возврат
status	int	Нет	Статус транзакции: 1 - COMPLETED, 2 - DECLINED, 3 - CANCELED, 4 - AUTHORIZED
workmode	int	Нет	Режим работы транзакций. По умолчанию - рабочий режим
sort	string	Нет	В каком порядке выполнять сортировку: id, date, type, status, amount
order	int	Нет	Использовать обратную сортировку. По умолчанию - да.
offset	int	Нет	Смещение относительно первого элемента
limit	int	Нет	Количество транзакций, которое надо выгрузить (по умолчанию - 10, максимально - 100)

Пример запроса

{ "date_start": "2020-09-01", "sort": "date", "order": 1, "limit": 100 }

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

{
    "response": {
        "count": 4,
        "items": [
            { ...transaction... },
            { ...transaction... },
            { ...transaction... }    
        ]
    }
}