Выплата

При выплате пользователь инициирует платеж, после чего ожидает зачисление средств на свой счет. Непосредственное участие пользователя в процессе проведения выплаты не требуется.

Регионы использования Китай (КНР)
Валюты выплаты CNY
Суммы платежей Информацию уточняйте у курирующего менеджера Flashpay. Также вы можете уточнить в Dashboard минимальную и максимальную сумму платежа, доступную в вашем проекте.
Время проведения платежа Информацию уточняйте у курирующего менеджера Flashpay.
Конвертация валют На стороне Flashpay
Возврат
Организация и стоимость подключения По согласованию с курирующим менеджером Flashpay

Основные операции

Интерфейсы
Payment Page Gate Dashboard
Выплата

Уточнить минимальную и максимальную сумму платежа, доступную в вашем проекте, вы можете в Dashboard. Для этого в Dashboard перейдите в раздел Проекты и выберите вкладку Платежные методы.

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

Выплата через Gate

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

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

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

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



Рис. 1. Здесь описаны шаги выплаты через Gate
  1. Пользователь инициирует выплату с использованием метода Alipay в вашей системе.
  2. Ваша система передает запрос на выплату в платежную платформу Flashpay.
  3. Платежная платформа отправляет вам ответ с информацией о получении запроса и о результате проверки его корректности. (Подробнее о формате ответа см. Формат ответа.)
  4. Платежная платформа обрабатывает запрос и отправляет его в сервис провайдера.
  5. Сервис провайдера оповещает платежную платформу о результате выплаты.
  6. Платежная платформа отправляет вам оповещение (callback) с результатом выплаты.
  7. Ваша система направляет пользователю информацию о результате выплаты.

Запрос

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

HTTP-метод запроса POST
Формат тела запроса JSON
Конечная точка/v2/payment/wallet/alipay/payout
Полная спецификация конечной точки /v2/payment/wallet/{payment_method}/payout
Табл. 1. Базовые параметры запроса на выплату

strictly required — параметр обязательно должен присутствовать в начальном запросе.

optional — параметр необязателен, но в общем случае его наличие в запросе способствует оптимизации проведения платежа, например упрощает процесс платежа для пользователя или повышает процент успешных платежей.
ОбъектОбъект/Параметр Описание

general
object
strictly required

project_id
integer
strictly required

Идентификатор проекта, полученный от Flashpay при интеграции.

Пример: 1234

payment_id
string
strictly required

Идентификатор платежа, уникальный в рамках проекта.

Пример: payment_47

signature
string
strictly required

Подпись запроса, составленная после определения всех параметров запроса. Подробнее о составлении подписи см. Использование подписи к данным.

customer
object
strictly required

id
string
strictly required

Идентификатор пользователя, уникальный в рамках проекта.

Пример: customer_123

ip_address
string
strictly required

IP-адрес устройства пользователя.

Пример: 198.51.100.47

first_name
string
strictly required

Имя пользователя на китайском языке.

Пример: 爱

last_name
string
strictly required

Фамилия пользователя на китайском языке.

Пример: 李

email
string
strictly required

Адрес электронной почты пользователя.

Пример: loveli@example.com

phone
string
strictly required

Номер телефона пользователя. Состоит из 11 цифр.

Пример: 12345678901

identify
object
strictly required

doc_number
string
strictly required

Номер удостоверения личности резидента КНР. Состоит из 18 цифр или из 17 цифр и буквы X.

Пример: 123456789123456789

account
object
strictly required

number
string
strictly required

Идентификатор аккаунта пользователя. Идентификатором аккаунта может быть электронная почта пользователя или номер телефона пользователя (11 цифр).

Пример: 12345678901

sender
object
strictly required

first_name
string
strictly required

Имя отправителя.

Пример: Mark

last_name
string
strictly required

Фамилия отправителя.

Пример: Cooper

day_of_birth
string
strictly required

Дата рождения отправителя в формате ДД-ММ-ГГГГ.

Пример: 10-10-1990

phone
string
strictly required

Номер телефона отправителя.

Пример: 12345678901

citizenship
string
strictly required

Гражданство отправителя (в соответствии со стандартом ISO 3166-1 alpha-2).

Пример: US

state
string
strictly required

Штат или регион отправителя.

Пример: Utah

address
string
strictly required

Адрес отправителя (улица, номер дома, номер корпуса, номер квартиры и т. п.).

Пример: 20 Main St

source_of_income
string
optional

Источник дохода отправителя. Если параметр не передать в запросе, по умолчанию будет использовано значение Salary.

Возможные значения:

  • Salary — для зарплаты отправителя;
  • Savings — для сбережений отправителя

Пример: Salary

payment_purpose
string
optional

Назначение перевода. Если параметр не передать в запросе, по умолчанию будет использовано значение Family Maintenance.

Возможные значения:

  • Family Maintenance — для содержания семьи;
  • Repatriation of Salary — для перевода зарплаты на другой счет самого отправителя. Это значение должно передаваться вместе со значением Self в параметре beneficiary_relationship;
  • Purchase of Goods/Services — для покупки товаров/услуг

Пример: Family Maintenance

beneficiary_relationship
string
optional

Взаимоотношения между отправителем и получателем. Если параметр не передать в запросе, по умолчанию будет использовано значение Family.

Возможные значения:

  • Family — для семьи;
  • Friends — для друзей;
  • Self — для перевода на другой счет самого отправителя. Это значение должно передаваться вместе со значением Repatriation of Salary в параметре payment_purpose;
  • Employee — для сотрудника;
  • Merchant — для продавца;
  • Others — для другого типа взаимоотношений

Пример: Family

identify
object
strictly required

doc_number
string
strictly required

Номер документа, подтверждающего личность отправителя.

Пример: 1234567

doc_type
string
strictly required

Тип документа, подтверждающего личность отправителя.

Возможные значения:

  • Passport — для передачи номера паспорта отправителя;
  • Identification Card — для передачи номера удостоверения личности резидента КНР

Пример: Passport

doc_expiry_date
string
strictly required

Дата истечения срока действия документа отправителя. Передается в формате в формате ДД-ММ-ГГГГ.

Пример: 31-10-2035

payment
object
strictly required

currency
string
strictly required

Код валюты платежа в формате ISO-4217 alpha-3.

Пример: CNY

amount
integer
strictly required

Сумма платежа в дробных единицах валюты без десятичного разделителя (точки или запятой) и пробелов за исключением случаев, когда у валюты нет дробной части.

Если у валюты нет дробных единиц (то есть количество разрядов дробных единиц равно нулю), то в этом параметре нужно указывать сумму в основных единицах валюты. Подробнее о разрядах дробных единиц у валют см. Использование дробных единиц валюты и Коды валют.

Пример: 100,00 CNY передается как 10000

При необходимости добавьте в запрос необязательные параметры, указанные в спецификации Gate: API Reference.

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

Рис. 2. Пример тела запроса на выплату
{
    "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": "爱",
        "last_name": "李",
        "email": "loveli@example.com",
        "phone": "12345678901",
        "identify": {
            "doc_number": "123456789123456789"
        }
    },
    "account": {
        "number": "12345678901"
    },
    "sender": {
        "first_name": "Mark",
        "last_name": "Cooper",
        "day_of_birth": "10-10-1990",
        "phone": "12345678901",
        "citizenship": "US",
        "state": "Utah",
        "address": "20 Main St",
        "source_of_income": "Salary",
        "payment_purpose": "Family Maintenance",
        "beneficiary_relationship": "Family",
        "identify": {
            "doc_number": "1234567",
            "doc_type": "Passport",
            "doc_expiry_date": "31-10-2035"
        }
    },
    "payment": {
        "currency": "CNY",
        "amount": 10000
    }
}

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

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

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

Рис. 3. Пример тела оповещения об успешной выплате
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "success",
        "date": "2024-12-07T19:08:45+0000",
        "method": "alipay",
        "sum": {
            "amount": 10000,
            "currency": "CNY"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123",
        "phone": "12345678901"
    },
    "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": "CNY"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "CNY"
        },
        "code": "0",
        "message": "Success",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "12345678901"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Рис. 4. Пример тела оповещения об отклоненной выплате
{
    "project_id": 1234,
    "payment": {
        "id": "payment_47",
        "type": "payout",
        "status": "decline",
        "date": "2024-12-07T19:08:45+0000",
        "method": "alipay",
        "sum": {
            "amount": 10000,
            "currency": "CNY"
        },
        "description": ""
    },
    "customer": {
        "id": "customer_123",
        "phone": "12345678901"
    },
    "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": "CNY"
        },
        "sum_converted": {
            "amount": 10000,
            "currency": "CNY"
        },
        "code": "20000",
        "message": "General decline",
        "provider": {
            "id": 12345,
            "payment_id": "123abc123-123",
            "auth_code": ""
        }
    },
    "account": {
        "number": "12345678901"
    },
    "signature": "U7HQO7ToISZhMPKdM4XrUKQtoYzFvoB3cs9CRd4xeYG2Q=="
}

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

Выплаты через Dashboard

При использовании интерфейса Dashboard можно проводить одиночные и массовые выплаты методом Alipay с единичной и пакетной отправкой запросов, называемые соответственно одиночными и массовыми.

  • Для проведения одиночной выплаты необходимо открыть форму выплаты, задать все необходимые параметры (включая метод), отправить запрос и убедиться в проведении выплаты.

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

    При этом должен использоваться файл формата CSV, структура которого соответствует требованиям, представленным в разделе Сведения о массовых платежах, а параметры выплат — должны соответствовать требованиям, представленным в разделе Выплаты через Gate этой статьи (за исключением пункта о подписи).

Более подробная информация о проведении выплат через Dashboard представлена в отдельной статье.