Cash

How to use Cash to submit a payout in Jordan.

Submit a payout by Cash in Jordan.

POST https://sandbox.transfersmile.com/api/payout

This endpoint allows you to submit a payout by Cash in Jordan.

Headers

Name	Type	Description
Content-Type*	String	application/json; charset=UTF-8
AppId*	String	Your App ID in payout platform.
Authorization*	String	SHA256($sorted_params + $app_key)

Request Body

Name	Type	Description
name*	String	Beneficiary's name - Length must between 5 and 100 -
document_type*	String	Beneficiary's personal identification type - Fixed value: individual -
country*	String	Fix value: JOR, for Jordan
method*	String	Fixed value: CASH
channel*	String	Fixed value: UPT
additional_remark*	String	The descriptor on the user's bank bill - Max. 40 chars -
notify_url*	String	Where pagsmile will send notifications to.
arrival_currency*	String	Arrival Currency - One of: USD, EUR -
source_currency*	String	Merchant Account Currency - One of: USD, EUR, GBP -
amount_type	String	Specify the amount value is fixed for merchant or beneficiary - One of: source_amount, arrival_amount(default) -
amount*	String	Payout Amount, 2 decimal numbers - check here -
fee_bear*	String	All fees charge to merchant or beneficiary - One of: merchant, beneficiary -
custom_code*	String	Merchant Payout ID - Max. 50 chars -

200: OK submit successfully

{
    "code": 200,
    "msg": "success",
    "time": 1628580845,
    "data": {
        "id": "TS202108100734054iRiUZFPXfQM",
        "custom_code": "custom_code9982674851738108",
        "arrival_amount": "1",
        "arrival_currency": "USD",
        "source_amount": "1",
        "source_currency": "USD",
        "status": "IN_PROCESSING"
    }
}

400: Bad Request order already existed

401: Unauthorized unauthorized

500: Internal Server Error fee not configured

500: Internal Server Error balance insufficient

500: Internal Server Error system error

Example

curl --location --request POST 'https://sandbox.transfersmile.com/api/payout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "name" : "LE ******** ANa",
    * "document_type": "individual", // fixed value: individual
    * "source_currency": "USD", 
    * "arrival_currency": "USD", // should be one of USD or EUR
    * "fee_bear": "merchant", // should be one of merchant, beneficiary
    * "method": "CASH", // fixed value: CASH
    * "channel": "UPT", // fixed value: UPT
    * "amount": "1",
    * "notify_url": "https://notify.url",
    * "custom_code" : "custom_code9982674851738108",
    * "additional_remark": "pagsmile payout test remark",
    * "country": "JOR"  // fixed value: JOR
}
'

Note: 94FAC*********************68548 is Pagsmile's test App ID for sandbox, and d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 is the authorization token associated with the test App ID.