Оплата

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

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

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

`https://plugin.{URL_сервера}/?label=label&currency_code=PKR&lang=en&wallet_type=jazzcash&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=jazzcash
currency_code=PKR
Доступные языки (lang): en, ur (Урду)

Обратите внимание на описание параметров 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/jazzcash?secret={pluginapi_secret}

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

Request method:

POST

Format:
JSON

Parameters:

Name

Type

Required

Max Length

Description

currency

string

yes

3

Код валюты.

label

string

yes

190

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

{
  "currency": "PKR",
  "label": "eligendi"
}

{ 
    'status': 'ok', 
    'params':  { 
        'identifier': '6234234234'
    } 
}

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

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

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

Request method:
POST

Format:
JSON

Parameters:

Name	Type	Required	Max Length	Description
currency_code	string	yes	3	PKR
wallet_type	string	yes	190	jazzcash
label	string	yes	190	Это уникальный идентификатор (ID) пользователя, осуществляющего платеж.
key1	string	yes	190	Transaction_ID, полученный от пользователя. Длинна "key1" 12 цифр.
amount	float	yes	256	Сумма платежа.
custom_transaction_id	string	yes	190	Идентификатор транзакции в системе Клиента. Должен быть уникальным.

{
    "currency_code": "PKR",
    "wallet_type": "jazzcash",
    "label": "55",
    "key1": "473811134684",
	"amount": 500,
    "custom_transaction_id": "123465477897"
}

{
    "status": "ok",
    "deposit": true,
    "deposit_amount": 500,
    "currency": {
        "code": "PKR",
        "symbol": "PKR"
    }
}

{
    "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"
}

{
    "status": "possible_transaction_created",
    "message": "Transaction not found. Possible transaction created"
}

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

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

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

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

{
    "signature": "0d8103294d3457bd4d22d0ff94c859d45ff9abb1",
    "wallet_type": "jazzcash",
    "amount": 700,
    "currency_code": "PKR",
    "label": "631317234",
    "converted_amount": {"USD": 4.61, "INR": 380, "EUR": 4.2, ... ,  "USDT": 4.60787289, "USDTTRC20": 0, "USDT20": 0},
    "direction": "ingoing",
    "created_datetime": "2023-08-25 10:47:40",
    "access_key": "FQ9jMwrNSkFbyMNqYFf6Ed4xeKmjHK",
    "additional_data": [
        {
            "activated_datetime": "2023-08-25 13:47:40",
            "exchanger_identifier": "99xxxx6690",
            "comment": "",
            "amount": "700",
            "currency_code": "PKR",
            "wallet_type": "jazzcash",
            "stockpiling_id": 1430926,
            "transaction_id": "47752123519",
            "transaction_type": 0,
            "plugin_custom_order_id": "h8JxcM123DbmAvfn",
            "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_id	string(1-36)	yes	Идентификатор вывода, если параметр не передается, то система генерирует withdrawal_id.
payment_system	string	yes	Платежная система.
amount	int	yes	Дополнительные требования: amount >= величина установленного минимального значения; amount <= величина установленного максимального значения.
currency_code	string(3)	yes	Код валюты.
is_test	boolean	yes	Параметр is_test может принимать одно из двух значений: true - если вывод тестовый; false - если вывод реальный.
label	string(1-36)	yes	Label пользователя, для которого проводится вывод.
account_name	string	optional	Имя держателя счета.
account_number	string	yes	Номер счета получателя.
bank_details.bank_code	string	yes	CNIC (national id card) - 13 цифр, номер CNIC, который юзер использовал для верификации своего кошелька JazzCash. Если указано неверно - выплата будет отклонена.
signature	string	yes	Подпись, формируемая с private_key.

{
    "withdrawal_id": "297",
    "payment_system": "jazzcash",
    "amount": 1000,
    "currency_code": "PKR",
    "label": "125199",
    "account_number": "03278516234",
    "account_name": "TestNameAcc",
    "payments_details": {},
    "bank_details": {
        "bank_code": "3460342887803"
    },
    "is_test": false,
    "signature": "2237e83a44bba650d982edc043fc5dd39e9b816c"
}

{
    "status": "ok",
}

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

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

{
    "status": "fail",
    "message": {
        "withdrawals_sum_amount": [
            "Insufficient balance"
        ]
    }
}

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

{
    "signature": "72ba3abd715986f6ba3b9d558c17074498f53d2c",
    "wallet_type": "jazzcash",
    "amount": 20000,
    "currency_code": "PKR",
    "label": "1237916",
    "converted_amount": {"USD": 9.19, "INR": 762, "EUR": 8.4, ... , "USDT": 9.20218423, "USDTTRC20": 0, "USDT20": 0},
    "direction": "outgoing",
    "created_datetime": "2023-08-24 16:52:02",
    "access_key": "FQ9jMwrNSkFbyMNqYFf6Ed4xeKmjHK",
    "additional_data": [
        {
            "activated_datetime": "",
            "exchanger_identifier": "",
            "comment": "",
            "amount": "20000",
            "currency_code": "PKR",
            "wallet_type": "jazzcash",
            "stockpiling_id": null,
            "transaction_id": "",
            "transaction_type": null,
            "plugin_custom_order_id": "",
            "withdrawal_id": "1071620",
            "withdrawal_status": 1,
            "account_number": "8541235719",
            "account_name": "",
            "account_email": "[email protected]",
            "bank_details": {
                "bank_code": null,
                "branch_code": null
            }
        }
    ]
}

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

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

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

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

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

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

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

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

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

Оплата

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

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

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

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

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

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

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

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

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

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

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

Оглавление: