You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Payment

  1. The user is provided with wallet details to which payment must be made.
  2. The user makes a payment in their wallet app and receives a unique transaction number.
  3. Next, the user enters a unique transaction number in the payment window, after which the transaction is activated.
  4. Paykassma sends a postback to the merchant's side.
  5. Funds are credited to the user’s balance on the merchant platform.

Payment window integration (plugin)

Example of a link to open a BAC IBAN Manual payment window:

https://plugin.{server_URL}/?
label=label
&currency_code=CRC
&lang=lang
&wallet_type=baciban_ml
&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=baciban_ml
currency_code=CRC
Available languages (lang): en, es

Тable of contents

Pay attention to the description of the parameters payment_url_success_id / payment_url_fail_id/ payment_url_pending_id and success_url / fail_url / pending_url.
To use payment_url_success_id / payment_url_fail_id / payment_url_pending_id you need to send the URLs to Paykassma support and use the received IDs in the parameters.
To use success_url / fail_url / pending_url you must use hashing URLs ( For more details on hashing click here ).

For the description of all the plug-in parameters click here.

API integration

Creating payment 

URL: https://api.{server_URL}/api/v1/transaction/create/baciban_ml?secret={pluginapi_secret}

At this stage we first accept a request for input through the payment system and in response we will provide the wallet details to which the user should transfer the payment. After the payment is made you will need to send a request to activate the transaction.

Request method:

POST

Format:
JSON

Parameters:

Name

Type

Required

Max Length

Description

currencystringyes3Currency code.

label

string

yes

190

The unique identifier (ID) of the user who makes the payment.


Request
{
  "currency": "CRC",
  "label": "eligendi"
}
Response Success
{
    "status": "ok",
    "params": {
        "Account number": "81351811",
        "is_check_amount": null
    }
}
Response Fail
{
    "status": "fail",
    "message": "MESSAGE"
}

Activation request

URL: http://api.{server_URL}/api/v1/possible-transaction?secret={pluginapi_secret}

Request method:
POST

Format:
form-data

Parameters:

Name

Type

Required

Max Length

Description

currency_codestringyes3Currency code (CRC).

wallet_type

string

yes

190

baciban_ml
labelstringyes190The unique identifier (ID) of the user who makes the payment. 
key1stringyes10Transaction number received from the user. Length from 6 to 10 digits.
screenshotfileyes
Screenshot of the payment from the user.
amountintyes256Payment amount.
custom_transaction_id

string

yes190

The identifier of the transaction in the Client's system.

Must be unique.

Response Success
{
    "status": "success",
    "message": "",
    "code": 20000,
    "data": [],
    "paginate": {
        "offset": 0,
        "total": 1,
        "limit": 1
    }
}
Response Fail
{
    "status": "fail",
    "message": "MESSAGE"
}

Deposit postback

For the general documentation on post backs click here.

Example of a deposit postback for a BAC IBAN Manual

{
  "signature": "aa23231cf517cf8d49aedssd2dac0a96acefdb9f",
  "wallet_type": "baciban_ml",
  "amount": 1500,
  "currency_code": "CRC",
  "label": "label",
  "direction": "ingoing",
  "created_datetime": "2025-11-14 14:17:26",
  "access_key": "uoslc0b3Lf5s1pcWYHi4_",
  "additional_data": [
    {
      "activated_datetime": "2025-11-14 14:17:25",
      "exchanger_identifier": null,
      "comment": "",
      "amount": "1500",
      "currency_code": "CRC",
      "wallet_type": "baciban_ml",
      "stockpiling_id": 11855,
      "transaction_id": "40245745",
      "transaction_type": 0,
      "plugin_custom_order_id": "orderid",
      "withdrawal_id": null,
      "withdrawal_status": null,
      "account_number": "",
      "account_name": "",
      "account_email": "",
      "bank_details": {
        "bank_code": "",
        "branch_code": ""
      }
    }
  ]
}

The Paykassma server is waiting for a response in json {"status": "ok"} response code 200, otherwise, when receiving a different response, Paykassma will forward the postback with a certain frequency.
Repeated postbacks must also be answered with {"status":"ok"} response code 200.

Withdrawals for users

Payments to users are made by using Sinpe Movil method (for more details on Sinpe Movil method click here).