Voucher - Выплата

Общая информация

Чтобы выполнить выплату через Gate с использованием метода Voucher:

1. Отправьте запрос с нужными параметрами и подписью на рабочий URL-адрес платежной платформы Flashpay.
2. Примите от платежной платформы Flashpay оповещение (callback) с массивом display_data. Отобразите содержимое массива пользователю.
3. Отправьте запрос на продолжение выплаты с нужными параметрами и подписью на рабочий URL-адрес платежной платформы Flashpay.
4. Примите от платежной платформы Flashpay оповещение (callback) с результатом выплаты.

Полная схема выплаты с использованием метода Voucher выглядит следующим образом.

Запрос

Далее представлена информация, необходимая для создания и отправки запроса на выплату с использованием метода Voucher.

Вот пример тела запроса на выплату с использованием метода Voucher:

{
    "general": {
        "project_id": 1234,
        "payment_id": "payment_47",
        "signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
    },
    "customer": {
        "id": "customer_123",
        "ip_address": "198.51.100.47",
        "first_name": "John",
        "last_name": "Doe",
        "email": "johndoe@example.com"
    },
    "account": {
        "number": 123456789
    },
    "payment": {
        "currency": "RUB",
        "amount": "10000",
        "service_code": "123456"
    }
}

Отображение платежной инструкции пользователю

Получив и обработав запрос на выплату, платежная платформа направит вам оповещение (callback) с платежной инструкцией для отображения пользователю.

Чтобы отобразить пользователю платежную инструкцию, используйте информацию из массива display_data.

Состав массива display_data с объектами, содержащими данные о доступных пользователю опциях, включая:

• package_id — ID доступной опции. Выбранный пользователем ID нужно будет отправить в параметре payment.package_id в запросе на продолжение выплаты. Может не передаваться в оповещении, если пользователю доступна только одна опция.
• title — Детальное описание доступной опции. Может не передаваться в оповещении, если пользователю доступна только одна опция.
• provider_amount — Сумма платежа.
• provider_currency — Валюта платежа.

Далее представлен фрагмент оповещения с массивом display_data, если пользователю доступны несколько опций.

"display_data": [
 {
	"package_id": "205",
	"title": "eSIM, 1GB, 7 Days, VietNam, V2, Speed: 2G,3G,4G,5G, Countries: Vietnam",
	"provider_amount": "990",
	"provider_currency": "RUB"
 }, 
 {
	"package_id": "220",
	"title": "eSIM, Unlimited, 1 Day, VietNam, V2, Speed: 2G,3G,4G,5G, Countries: Vietnam",
	"provider_amount": "1067",
	"provider_currency": "RUB"
 }, 
 {
	"package_id": "263",
	"title": "eSIM, Unlimited Essential, 1 Day, VietNam, V2, Speed: 2G,3G,4G,5G, Countries: Vietnam",
	"provider_amount": "1276",
	"provider_currency": "RUB"
 }, 
 {
	"package_id": "526",
	"title": "eSIM, Unlimited Plus, 1 Day, VietNam, V2, Speed: 2G,3G,4G,5G, Countries: Vietnam",
	"provider_amount": "2553",
	"provider_currency": "RUB"
 }  
]

Далее представлен фрагмент оповещения с массивом display_data в том случае, если доступна только одна опция.

"display_data": [
 {
	"provider_amount": "990",
	"provider_currency": "RUB"
 }   
]

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

Далее представлена информация, необходимая для создания и отправки запроса на продолжение выплаты с использованием метода Voucher.

Вот пример тела запроса на выплату с использованием метода Voucher:

{
	"general": {
		"project_id": 1234,
		"payment_id": "payment_47",
		"signature": "kUi2x9dKHAVNU0FYldJrxh4yo+52Kt8KU+Y19vySO/RLUkDJrOcZzUCwX6R/ekpZhkIQg=="
	},
	"payment": {
		"package_id": "123"
	}
}

Оповещение (callback)

В методе Voucher результат выплаты платежная платформа возвращает в оповещении. Подробнее о структуре оповещений см. Оповещения.

Вот пример тела оповещения с информацией об успешно выполненной выплате:

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Voucher",
        "sum": {
            "amount": 10000,
            "currency": "RUB"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "RUB"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Вот пример тела оповещения с информацией об отклоненной выплате.

{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "Voucher",
        "sum": {
            "amount": 10000,
            "currency": "RUB"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123"
    },
    "operation": {
        "id": 47,
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "created_date": "2024-12-07T19:08:05+0000",
        "request_id": "1a23456bc7890de",
        "sum_initial": {
            "amount": 10000,
            "currency": "RUB"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "RUB"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

Дополнительные материалы

• Схемы взаимодействия
• Модель проведения платежей
• Работа с подписью
• Статусы операций и коды ответов