Payout

Process a payout

This API is used for payout request submission. It requires some parameters that are encrypted with a secret key and merchant key to submit payouts.

Request Body

  • Name
    key
    Type
    string
    required
    Description

    Key generated from parameters with API key and API secret encryption.

cURL
curl --request POST \
  --url https://staging.s88pay.net/api/v1/payout/{merchant_code} \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "<string>"
    }'
Processing request...

Parameters

  • Name
    merchant_code
    Type
    string
    required
    Description
    Provide by Provider.
  • Name
    transaction_code
    Type
    string
    required
    Description
    Generated by the operator. Must be unique for each transaction.
  • Name
    transaction_timestamp
    Type
    integer
    required
    Description
    Generate by the operator.

    This parameter describes the transaction request TimeRanges. The more detailed information regardings timestamps, please visit epochconverter.

    Please note that we only process the timestamp on these limit.

    min: 1 hour before now

    max: 5 minutes after now

  • Name
    payout_code
    Type
    string
    required
    Description
    Example P001. Please contact the administrator to get your payment code.
  • Name
    transaction_amount
    Type
    double
    required
    Description
    The amount of of the transaction.
  • Name
    user_id
    Type
    string
    required
    Description
    Can be filled by the user key field on your system. For example : USR98323923
  • Name
    currency_code
    Type
    string
    required
    Description
    Please refer to currency list.
  • Name
    address
    Type
    string
    required
    Description
    Required for crypto payout This is the user's crypto wallet address.
  • Name
    bank_account_number
    Type
    string
    required
    Description
    Required for (INR, CNY, VND, THB, KRW, BDT, JPY,BRL Payout) for BRL used ID Card with 11 digits
  • Name
    ifsc_code
    Type
    string
    required
    Description
    Required only For INR Payout
  • Name
    bank_code
    Type
    string
    required
    Description
    Required for ( INR, CNY, VND, THB, BDT, IDR, MYR, KRW, JPY,BRL and PHP Payout)

    The available INR bank code is displayed on the bank code section in S88pay Backoffice in Withdraw Menu.

    The available Bank Code

  • Name
    bank_name
    Type
    string
    required
    Description
    Required for ( INR, CNY, VND, THB, BDT, IDR, MYR, KRW, JPY,BRL and PHP Payout)

    The available INR bank code is displayed on the bank code section in S88pay Backoffice in Withdraw Menu.

    The available Bank Code

  • Name
    branch_code
    Type
    string
    Description
    Required only for JPY. Branch Code.
  • Name
    account_name
    Type
    string
    required
    Description
    Bank Account / Wallet name.
  • Name
    callback_url
    Type
    string
    Description
    Url callback. We will send updated status from a transaction to your side using this url. You can choose either set it on our BO or by this parameter. If you set both then we will send a callback to both urls as well.
  • Name
    phone_number
    Type
    string
    Description
    Required for BDT, 11 digits numbers without country code (ex. 01812345678 )

Parameters Object
{
  "merchant_code": "ABC123",
  "transaction_code": "TRX123456789",
  "transaction_timestamp": 1649700000,
  "payout_code": "P001",
  "transaction_amount": 100.50,
  "user_id": "user123",
  "currency_code": "USD",
  "address": "0x123456789abcdef",
  "bank_account_number": "1234567890",
  "ifsc_code": "12323",
  "bank_code": "XYZ",
  "bank_name": "Example Bank",
  "branch_code": null,
  "account_name": "John Doe",
  "callback_url": "https://example.com/callback"
}

These parameters must be encrypted before being sent through the key body.

Return

Returns a transaction status object. This call returns an error if an error occurs.

{
    "success": true,
    "message": "Invalid Transaction Code ( not unique )!, error code 111"
}
{
    "success": true,
    "message": "request withdraw successful"
}