Cash

How to use Cash to submit a payout in Turkey.

Submit a payout by Cash in Turkey

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

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

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 identification type - individual or business -
fee_bear*	string	Processing fee charges to merchant or beneficiary - One of: merchant, beneficiary -
custom_code*	string	Merchant Payout ID - Max. 50 chars -
method*	string	Fixed value: CASH
channel*	string	Fixed value: UPT
arrival_currency*	string	Fixed value: TRY
source_currency*	string	Merchant Account Currency - One of: USD, EUR, GBP, TRY -
amount_type	string	Specify the amount value is fixed for merchant or beneficiary - One of: source_amount, arrival_amount(default) -
amount*	number	Payout Amount, 2 decimal numbers - Min 10.00, Max 100,000.00 -
country*	string	Fixed Valud: TUR, for Turkey
addtional_remark*	string	Descriptor on the user's bank bill - Max. 40 chars -
notify_url*	string	Where pagsmile will send notification to.

200: OK submit successfully

{
    "code": 200,
    "msg": "success",
    "time": 1628580845,
    "data": {
        "id": "TS202108100734054iRiUZFPXfQM",
        "custom_code": "custom_code9982674851738108",
        "arrival_amount": "10.01",
        "arrival_currency": "TRY",
        "source_amount": "10.01",
        "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

Payment Flow

After successfully creating a CASH UPT payout order, call the Payout Detail API to obtain the reference number from the response parameter "upt_ref".

It is recommended to notify the recipient of the following information via email, SMS, etc.:

1. Reference

Remind the recipient to visit a UPT service point within 7 days to withdraw the cash. When withdrawing, the recipient must present the reference number. If the recipient didn't withdraw the cash in 7 days, the payout will be refunded.

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": "GUILHERME ****** SOUZA",
    * "amount": "10.01",
    * "arrival_currency": "TRY", // fixed value: TRY
    * "custom_code" : "custom_code_your_order_id",
    * "document_type": "business", // individual or business
    * "fee_bear": "merchant",
    * "method": "CASH",   // fixed value: CASH
    * "channel": ""UPT", // fixed value: UPT
    * "notify_url": "https://notify.url",
    * "source_currency": "USD", // supported: USD GBP EUR TRY
    * "additional_remark": "pagsmile payout test remark",
    * "country": "TUR", // fixed value: TUR
}'

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