Оплата

  1. Пользователю предоставляются реквизиты кошелька, на которые необходимо совершить оплату.
  2. Пользователь совершает оплату в своем приложении кошелька и получает уникальный номер транзакции.
  3. Далее пользователь вводит уникальный номер транзакции в платежном окне - активируется транзакцию.
  4. Paykassma отсылает постбек на сторону мерчанта.
  5. Средства начисляются на баланс пользователя на платформе мерчанта.

Интеграция через платежное окно (plugin)

Пример ссылки на открытие платежного окна Rocket:

https://plugin/.{URL_сервера}/?
label=label
&currency_code=BDT
&lang=lang
&wallet_type=rocket
&custom_transaction_id=custom_transaction_id
&fixed_amount=fixed_amount
&payment_url_success_id=2
&payment_url_pending_id=3
&payment_url_fail_id=1
&success_url=hash
&fail_url=hash
&pending_url=hash


wallet_type=rocket
currency_code=BDT
Доступные языки (lang): en, bn

Обратите внимание на описание параметров payment_url_success_id / payment_url_fail_id / payment_url_pending_id и success_url / fail_url / pending_url

Для использования payment_url_success_id / payment_url_fail_id / payment_url_pending_id необходимо передать URL'ы саппорту Paykassma, и использовать полученные ID в параметрах.

Для использования success_url / fail_url / pending_url необходимо использовать хэширование URL'ов (подробнее про хэширование см. здесь).

Описание всех параметров плагина смотрите здесь.

Интеграция через клиентский API

Создание платежа

URL: https://api.{ URL сервера }/api/v1/transaction/create/rocket?secret={pluginapi_secret}

В данном случае сначала мы принимаем запрос на ввод по платежной системе, далее в ответе мы предоставим реквизиты кошелька, на который пользователь должен перевести платеж.

Request method:

POST

Format:
JSON

Parameters:

Name

Type

Required

Max Length

Description

currencystringyes3Код валюты.

label

string

yes

190

Это уникальный идентификатор (ID) пользователя, осуществляющего платеж.


Request
{
  'currency': 'BDT', 
  'label': 'eligendi'
}


Response Success:
{
    "status": "ok",
    "params": {
        "identifier": "01601606950"
    }
}


Response Fail
{
    'status': 'fail',
    'message': 'MESSAGE'
}

Запрос активации

URL: http://api.{ URL сервера }/api/v1/transaction/activate?secret={pluginapi_secret}

На этом шаге пользователь передает номер транзакции, который вы пересылаете на сторону Paykassma для активации.

Request method:
POST

Format:
JSON

Parameters:

Name

Type

Required

Max Length

Description

currency_codestringyes3Код валюты.

wallet_type

string

yes

190

Метод (Платежная система).
labelstringyes190Это уникальный идентификатор (ID) пользователя, осуществляющего платеж.
key1stringyes190

Transaction_ID, полученный от пользователя.

Rocket - 10 цифр

amountfloatyes256Сумма платежа.
custom_transaction_id

string

yes190

Идентификатор транзакции в системе Клиента. Должен быть уникальным.


Request
{
    "currency_code": "BDT",
    "wallet_type": "rocket",
    "label": "55",
    "amount": 500,
    "key1": "1720943730",
    "custom_transaction_id": "123465477897"
}


Response Success
{
    "status": "ok",
    "deposit": true,
    "deposit_amount": 500,
    "currency": {
        "code": "BDT",
        "symbol": "BDT"
    }
}


Response Pending (при активации подозрительной транзакции)
{
    "status": "pending",
    "message": "The deposit status check has been started. The operation may take longer than expected. Upon completion of the verification, the funds will be credited to your account"
}


Response Possible Transaction Created (если включен функционал "Возможные транзакции")
{
    "status": "possible_transaction_created",
    "message": "Transaction not found. Possible transaction created"
}


Response Fail
{
    'status': 'fail',
    'message': 'MESSAGE'
}

Постбек депозита

Общую документацию по постбекам смотрите здесь.

Пример постбека на депозит Rocket

{
    "signature": "6ae0a07db755bce5753d80ea2bfad4fabe2f7ba3",
    "wallet_type": "rocket",
    "amount": 500,
    "currency_code": "BDT",
    "label": "53928",
    "direction": "ingoing",
    "created_datetime": "2023-08-17 07:34:20",
    "access_key": "FQ9jMwrNSkFbyMNqYFf6Ed4xeKmjHK",
    "additional_data": [
        {
            "activated_datetime": "2023-08-17 10:33:39",
            "exchanger_identifier": null,
            "comment": "",
            "amount": "300",
            "currency_code": "BDT",
            "wallet_type": "rocket",
            "stockpiling_id": 1058,
            "transaction_id": "1692257577",
            "transaction_type": 1,
            "plugin_custom_order_id": "kuwnoGHyRCKu6qzE",
            "withdrawal_id": null,
            "withdrawal_status": null,
            "account_number": "",
            "account_name": "",
            "account_email": "",
            "bank_details": {
                "bank_code": "",
                "branch_code": ""
            }
        },
        {
            "activated_datetime": "2023-08-17 10:34:20",
            "exchanger_identifier": null,
            "comment": "",
            "amount": "200",
            "currency_code": "BDT",
            "wallet_type": "rocket",
            "stockpiling_id": 1058,
            "transaction_id": "1692257588",
            "transaction_type": 1,
            "plugin_custom_order_id": "kuwnoGHyRCKu6qzE",
            "withdrawal_id": null,
            "withdrawal_status": null,
            "account_number": "",
            "account_name": "",
            "account_email": "",
            "bank_details": {
                "bank_code": "",
                "branch_code": ""
            }
        }
    ]
}

Сервер Paykassma ожидает ответ в json {"status":"ok"} код ответа 200, в противном случае, при получении отличающегося ответа, Paykassma будет пересылать постбек с определенной периодичностью.
На повторные постбеки необходимо также отвечать {"status":"ok"} код ответа 200.

Выводы / выплаты пользователям

Общую документацию по выводам смотрите здесь.

Создание вывода

URL: https://api.{ URL сервера }/v2/withdrawal/create

Request method:

POST

Format:
JSON

Parameters:

Name

Type

Required

Description

withdrawal_idstring(1-36) yes Идентификатор вывода, если параметр не передается, то система генерирует withdrawal_id.
payment_systemstring yesПлатежная система.
amount

int


required

Дополнительные требования:

  1. amount >= величина установленного минимального значения; 
  2. amount <= величина установленного максимального значения. 
currency_codestring(3) yesКод валюты.

is_test

booleanyes

Параметр is_test может принимать одно из двух значений:

  • true - если вывод тестовый; 
  • false - если вывод реальный. 

label

string(1-36)

yes

Label пользователя, для которого проводится вывод.

account_emailstring yesЕ-mail держателя счета.
account_numberstring 

yes

Номер счета получателя.

 11-12 цифр, первые две - "01".

 Пример: "01XXXXXXXXX" , "01XXXXXXXXXX".

signaturestringyesПодпись, формируемая с private_key.


Request
{
  "withdrawal_id": "af84c26f-931d-4c28-a30d-7b75e46b7685",
  "payment_system": "rocket",
  "amount": 6000,
  "currency_code": "BDT",
  "is_test": true,
  "label": "c81594cc-e4b1-4ed5-914c-3817f2ccf13a",
  "account_email": "[email protected]",
  "account_number": "01642234663",
  "signature": "98565041a9e126d325e864da0ba3d467f6ab0566"
}
Response Success
{
    "status": "ok",
}
Response Fail
{
    'status': 'fail',
    'message': 'MESSAGE'
}

*Если при попытке создания заявки на вывод сумма балансов счетов в валюте заявки будет меньше, чем общая сумма новой и еще незавершенных заявок, то отобразится ошибка 'Недостаточный баланс' (для настройки данного функционала обратитесь в ТП Paykassma).

Response Fail (при недостаточном балансе)
{
    "status": "fail",
    "message": {
        "withdrawals_sum_amount": [
            "Insufficient balance"
        ]
    }
}

Пример постбека на вывод

{
    "signature": "654d7d7bbb46142add67d9c6b148e81d8aa2b8b6",
    "wallet_type": "rocket",
    "amount": 6000,
    "currency_code": "BDT",
    "label": "c81594cc-e4b1-4ed5-914c-3817f2ccf13a",
    "direction": "outgoing",
    "created_datetime": "2023-08-20 19:33:01",
    "access_key": "FQ9jMwrNSkFbyMNqYFf6Ed4xeKmjHK",
    "additional_data": [
        {
            "activated_datetime": "",
            "exchanger_identifier": "",
            "comment": "test",
            "amount": "6000",
            "currency_code": "BDT",
            "wallet_type": "rocket",
            "stockpiling_id": null,
            "transaction_id": "",
            "transaction_type": null,
            "plugin_custom_order_id": "",
            "withdrawal_id": "af84c26f-931d-4c28-a30d-7b75e46b7685",
            "withdrawal_status": 5,
            "account_number": "01642234663",
            "account_name": "",
            "account_email": "[email protected]",
            "bank_details": {
                "bank_code": null,
                "branch_code": null
            }
        }
    ]
}
Сервер Paykassma ожидает ответ в json {"status":"ok"} код ответа 200, в противном случае, при получении отличающегося ответа, Paykassma будет пересылать постбек с определенной периодичностью.
На повторные постбеки необходимо также отвечать {"status":"ok"} код ответа 200.

После обработки вывода, Paykassma пришлет постбек о результате вывода со статусом (withdrawal_status).

Статусы выводов

1SUCCESSСтатус для вывода, когда заявка на вывод была успешно обработана.
5FAILСтатус для вывода, когда заявка на вывод была отклонена.

Создание заявки на выплату в ЛК Paykassma

Для создания заявки на вывод, необходимо перейти на страницу Выводы (Оплаты → Выводы) и выполнить следующие шаги:

  1. Нажмите на кнопку "Добавить заявку на вывод".



  2. Выберите из списка нужную ПС.



  3. Заполните поля для создания заявки в следующем окне (список полей стандартизирован и не все поля являются обязательными. Для создания заявки по определенной ПС, необходимо заполнить обязательные поля для этой ПС).
    Обязательные поля для выплаты Rocket:
    - Лейбл (ID юзера)
    - Сумма
    - Валюта
    - Кошелек получателя
    - Email получателя

  4. После оплаты статус вывода поменяется.



    Paykassma не высылает постбек по выводам, созданным вручную.

Оглавление: