Оплата

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

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

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

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

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

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

Request method:

POST

Format:
JSON

Parameters:

Name

Type

Required

Max Length

Description

currencystringyes3Код валюты.

label

string

yes

190

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


Request
{
  'currency': 'INR', 
  'label': 'eligendi'
}
Response Success
{ 
    'status': 'ok', 
    'params':  { 
        'identifier': '6234234234'
    } 
}
Response 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_codestringyes3INR

wallet_type

string

yes

190

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

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

Длина "key1" 11-12 цифр.

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

string

yes190

Идентификатор транзакции в системе Клиента.

Должен быть уникальным.

Request
{
    "currency_code": "INR",
    "wallet_type": "paytm",
    "label": "55",
    "key1": "47381113468",
	"amount": 500,
    "custom_transaction_id": "123465477897"
}


Response Success
{
    "status": "ok",
    "deposit": true,
    "deposit_amount": 500,
    "currency": {
        "code": "INR",
        "symbol": "INR"
    }
}
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'
}

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

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

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

{
    "signature": "0d8103294d3457bd4d22d0ff94c859d45ff9abb1",
    "wallet_type": "paytm",
    "amount": 700,
    "currency_code": "INR",
    "label": "631317234",
    "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": "INR",
            "wallet_type": "paytm",
            "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"} c кодом ответа 200, в противном случае, при получении отличающегося ответа, Paykassma будет пересылать постбек с определенной периодичностью.
На повторные постбеки необходимо также отвечать {"status":"ok"} с кодом ответа 200.

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

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

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

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

yes

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

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

is_test

booleanyes

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

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

label

string(1-36)

yes

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

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

yes

Номер счета получателя, 10 цифр.

signaturestringyesПодпись, формируемая с private_key.
Request
{
	"withdrawal_id": "85858053",
	"payment_system": "paytm",
	"amount": 1000,
	"currency_code": "INR",
	"label": "160496026",
	"comment": "withdrawal",
	"account_number": "1234560079",
	"is_test": true,
	"signature": "2266a77c54925494335c12d365bdbf67f7e6e9c6"
}
Response Success
{
    "status": "ok",
}
Response Fail
{
    'status': 'fail',
    'message': 'MESSAGE'
}

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

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

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

{
    "signature": "72ba3abd715986f6ba3b9d558c17074498f53d2c",
    "wallet_type": "paytm",
    "amount": 20000,
    "currency_code": "INR",
    "label": "1237916",
    "direction": "outgoing",
    "created_datetime": "2023-08-24 16:52:02",
    "access_key": "FQ9jMwrNSkFbyMNqYFf6Ed4xeKmjHK",
    "additional_data": [
        {
            "activated_datetime": "",
            "exchanger_identifier": "",
            "comment": "",
            "amount": "20000",
            "currency_code": "INR",
            "wallet_type": "paytm",
            "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 пришлет постбек о результате вывода со статусом, подписанный сигнатурой.

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

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

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

Выплаты пользователям осуществляются через метод IMPS (подробнее про метод IMPS смотрите здесь).

Оглавление: