Order Payout

Order Payout

Postman Collection

Payout

URL

POST : /v1/service/payout/orders

Headers

Content-Type  (String)   required
application/json

Authorization  (String)   required
Basic Auth

Accept  (String)   required
application/json

Body Params

contactId  (String)   Optional
Unique Contact Code (Max Length: 20)

amount  (String)   Required
Recharge Amount (Max Length: 5)

purpose  (String)   Required
Purpose of Payout Order (Max Length: 30)

mode  (String)   Required
Payout Order Mode (Max Length: 15)

narration  (String)   Required
Payout order narration (Max Length: 15)

remark  (String)   Required
Payout order remark (Max Length: 15)

clientRefId  (Number)   Required
Unique Reference number (Max Length: 30)

Generate Signature

Example Signature

    $base64_num=base64_encode(json_encode(
        [
            'contactId' => "CONT_18578XXXX0580306C74F",
            'amount' => "1",
            'purpose' => "salary_disbursement",
            'mode' => "IMPS",
            'narration' => "narration or retailer_id|retailer_name|retailer_email|retailer_mobile|retailer_service" ,
            'remark' => "remark",
            'clientRefId' => "CRF37XXXX47484"
        ]
    ));
    hash('sha256', $base64_num."/v1/service/payout/orders{{$client_key}}####{{$salt_key}}");

Request

Example Request

    curl --location '/v1/service/payout/orders' \
        --header 'signature: 82331c16fe734582af608dbbb8eb17f840c4083301ea13146b716b544b1a2329' \
        --header 'Content-Type: application/json' \
        --header 'Authorization: Basic Og==' \
        --data '{
            "contactId": "CONT_18578XXXX0580306C74F",
            "amount": "1",
            "purpose": "salary_disbursement",
            "mode": "IMPS",
            "narration": "narration",
            "remark": "remark",
            "clientRefId": "CRF37XXXX47484"
        }'

Response Samples

SUCCESS

    {
        "code": "0x0200",
        "message": "Order accepted successfully",
        "status": "SUCCESS",
        "data": {
            "clientRefId": "CRFXXXX8747484",
            "orderRefId": "REF22905XXXX70835580BC0",
            "status": "queued"
        }
    }

FAILED

    {
        "code": "0x0202",
        "status": "FAILURE",
        "message": "Order Not Found"
    }

Response Code

Status Code	Status	Message
0x0200	SUCCESS	TRANSACTION SUCCESSFULL
0x0201	UNAUTHORIZED	UNAUTHORIZED USER
0x0202	FAILURE	FAILURE USER
0x0203	MISSING_PARAMETER	MISSING PARAMETER
0x0204	CONNECTION_TIMEOUT	CONNECTION TIMEOUT
0x0205	SOMETHING_WENT_WRONG	SOMETHING WENT WRONG
0x0206	PENDING	TRANSACTION PENDING
0x0207	REVERSED	TRANSACTION REVERSED
0x0209	REDIRECT	REDIRECT URL