Versions Compared

Old Version 1

changes.mady.by.user christie

Saved on

compared with

New Version Current

changes.mady.by.user grayson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Оплата

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

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

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

http
https://plugin.{URL_сервера}/?
label=label
&

currency_code=PKR
&

lang=lang
&

wallet_type=easypaisa
&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


Code Block
wallet_type=easypaisa
currency_code=PKR
Доступные языки (lang): en, ur (Урду)
Info

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

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

Request method:

POST

Format:
JSON

Parameters:

Name

Type

Required

Max Length

Description

currencystringyes3Код валюты.

label

string

yes

190

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


Code Block
languagephp
themeDJango
titleRequest
{
  'currency': 'PKR',
  'label': 'eligendi'
}


Code Block
languagephp
themeDJango
titleResponse Success
{
    'status': 'ok',
    'params':  {
        'identifier': '03432312313'
                      }
}


Code Block
languagephp
themeDJango
titleResponse Fail
{
    '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_codestringyes3Код валюты.

wallet_type

string

yes

190

Значение из списка доступных ПС, например: easypaisa и тд.
labelstringyes190Это уникальный идентификатор (ID) пользователя, осуществляющего платеж.
key1stringyes190Transaction_ID, полученный от пользователя (11 цифр).
amountfloatyes256Сумма платежа.
custom_transaction_id

string

yes190

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


Code Block
languagephp
themeDJango
titleRequest
{
  "currency_code": "PKR",
  "label": "786442",
  "wallet_type": "easypaisa",
  "key1": "23936785601",
  "amount": 1200,
  "custom_transaction_id": "3158538"
}


Code Block
languagephp
themeDJango
titleResponse Success
{
    "status": "ok",
    "deposit": true,
    "deposit_amount": 6000,
    "currency": {
        "code": "PKR",
        "symbol": "PKR"
    }
}


Code Block
languagephp
themeDJango
titleResponse 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"
}


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


Code Block
languagephp
themeDJango
titleResponse Fail
{
    'status': 'fail',
    'message': 'MESSAGE'
}

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

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

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

Code Block
languagephp
themeDJango
collapsetrue
{
    "signature": "2ad41735cd2d225cb30fe0665e83a3ade8618e0d",
    "wallet_type": "easypaisa",
    "amount": 1000,
    "currency_code": "PKR",
    "label": "545932754",
    "direction": "ingoing",
    "created_datetime": "2023-09-26 19:37:02",
    "access_key": "TA25Ea9sjPUFJvIG",
    "additional_data": [
        {
            "activated_datetime": "2023-09-26 22:37:00",
            "exchanger_identifier": "923139471223",
            "comment": "",
            "amount": "1000",
            "currency_code": "PKR",
            "wallet_type": "easypaisa",
            "stockpiling_id": 4819603,
            "transaction_id": "23936218009",
            "transaction_type": 0,
            "plugin_custom_order_id": "5586199250",
            "withdrawal_id": null,
            "withdrawal_status": null,
            "account_number": "",
            "account_name": "",
            "account_email": "",
            "bank_details": {
                "bank_code": "",
                "branch_code": ""
            }
        }
    ]
}
Warning
Сервер 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_idstringyes 

Идентификатор вывода.

Если параметр не передается, то система генерирует withdrawal_id.

payment_systemstring yesПлатежная система.
amount

int


required

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

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

label

string

yes

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

account_numberstring 

yes

Одиннадцатизначный номер счета пользователя Клиента в easypaisa, в формате 03ХХХХХХХХХ.

Валидация:

  • Цифры: 0-9.
account_namestringyesИмя держателя аккаунта (ограничение по кол-ву символов - 30, только латинский алфавит, без иных символов и цифр).
Пользователю необходимо указывать имя аккаунта, привязанное к указанному номеру аккаунта.
bank_details.bank_codestringyesCNIC (national id card) - 13 цифр, номер CNIC, который юзер использовал для верификации своего кошелька EasyPaisa. Если указано неверно - выплата будет отклонена.

is_test

booleanyes

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

  • true - если вывод тестовый;
  • false - если вывод реальный. 
signaturestringyesПодпись, формируемая с private_key.


Code Block
themeDJango
titleRequest
{
  "withdrawal_id": "1234567test",
  "payment_system": "easypaisa",
  "amount": 10000,
  "currency_code": "PKR",
  "label": "125199",
  "account_number": "03405135211",
  "account_name": "Muhammad Saqib Mushtaq",  
  "bank_details": {
      "bank_code": "3460342887803"
  },
  "is_test": true,
  "signature": "2e56786153bec935220fa1e9409ab24bd99cf9e8"
}


Code Block
languagephp
themeDJango
titleResponse Success
{
    "status": "ok"
}


Code Block
themeDJango
titleResponse Fail
{
    'status': 'fail',
    'message': 'MESSAGE'
}

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

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

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

Code Block
languagephp
themeDJango
collapsetrue
{
    "signature": "2ad41735cd2d225cb30fe0665e83a3ade8618e0d",
    "wallet_type": "easypaisa",
    "amount": 1000,
    "currency_code": "PKR",
    "label": "545932754",
    "direction": "ingoing",
    "created_datetime": "2023-09-26 19:37:02",
    "access_key": "TA25Ea9sjPUFJvIG",
    "additional_data": [
        {
            "activated_datetime": "2023-09-26 22:37:00",
            "exchanger_identifier": "03ХХХХХХХХХ",
            "comment": "",
            "amount": "1000",
            "currency_code": "PKR",
            "wallet_type": "easypaisa",
            "stockpiling_id": 4819603,
            "transaction_id": "23936218009",
            "transaction_type": 0,
            "plugin_custom_order_id": "5586199250",
            "withdrawal_id": null,
            "withdrawal_status": null,
            "account_number": "",
            "account_name": "",
            "account_email": "",
            "bank_details": {
                "bank_code": "",
                "branch_code": ""
            }
        }
    ]
}


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

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

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

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

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

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


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


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


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


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

Оглавление:

Table of Contents
excludeОглавление: