# Cash

## Submit a payout by Cash in Turkey

<mark style="color:green;">`POST`</mark> `https://sandbox.transfersmile.com /api/payout`

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

#### Headers

| Name                                            | Type   | Description                         |
| ----------------------------------------------- | ------ | ----------------------------------- |
| Content-Type<mark style="color:red;">\*</mark>  | string | application/json; charset=UTF-8     |
| AppId<mark style="color:red;">\*</mark>         | string | Your App ID in payout platform.     |
| Authorization<mark style="color:red;">\*</mark> | string | SHA256($sorted\_params + $app\_key) |

#### Request Body

| Name                                                | Type   | Description                                                                                                                  |
| --------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------- |
| name<mark style="color:red;">\*</mark>              | string | <p>Beneficiary's name<br>- Length must between 5 and 100 -</p>                                                               |
| document\_type<mark style="color:red;">\*</mark>    | string | <p>Beneficiary's identification type</p><p>- individual or business -</p>                                                    |
| fee\_bear<mark style="color:red;">\*</mark>         | string | <p>All fees charge to merchant or beneficiary<br>- One of: merchant, beneficiary -</p>                                       |
| custom\_code<mark style="color:red;">\*</mark>      | string | <p>Merchant Payout ID<br>- Max. 50 chars -</p>                                                                               |
| method<mark style="color:red;">\*</mark>            | string | Fixed value: CASH                                                                                                            |
| channel<mark style="color:red;">\*</mark>           | string | Fixed value: UPT                                                                                                             |
| arrival\_currency<mark style="color:red;">\*</mark> | string | Fixed value: TRY                                                                                                             |
| source\_currency<mark style="color:red;">\*</mark>  | string | <p>Merchant Account Currency<br>- One of: USD, EUR, GBP, TRY -</p>                                                           |
| amount\_type                                        | string | <p>Specify the amount value is fixed for merchant or beneficiary<br>- One of: source\_amount, arrival\_amount(default) -</p> |
| amount<mark style="color:red;">\*</mark>            | number | <p>Payout Amount, 2 decimal numbers</p><p>- Min 10.00, Max 100,000.00 - </p>                                                 |
| country<mark style="color:red;">\*</mark>           | string | Fixed Valud: TUR, for Turkey                                                                                                 |
| addtional\_remark<mark style="color:red;">\*</mark> | string | <p>Descriptor on the user's bank bill<br>- Max. 40 chars -</p>                                                               |
| notify\_url<mark style="color:red;">\*</mark>       | string | Where pagsmile will send notification to.                                                                                    |

{% tabs %}
{% tab title="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"
    }
}
```

{% endtab %}

{% tab title="400: Bad Request order already existed" %}

```
{
    "code": 4001020,
    "msg": "order already existed",
    "time": 1628580940,
    "data": {}
}
```

{% endtab %}

{% tab title="401: Unauthorized unauthorized" %}

```
{
    "code": 4004003,
    "msg": "permission denied",
    "time": 1637224716,
    "data": {
        ... ...
    }
}
```

{% endtab %}

{% tab title="500: Internal Server Error fee not configured" %}

```
{
    "code": 5001003,
    "msg": "fee not configured",
    "time": 1637224716,
    "data": {
        ... ...
    }
}
```

{% endtab %}

{% tab title="500: Internal Server Error balance insufficient" %}

```
{
    "code": 5001102,
    "msg": "balance insufficient",
    "time": 1637224716,
    "data": {
        ... ...
    }
}
```

{% endtab %}

{% tab title="500: Internal Server Error system error" %}

```
{
    "code": 5001000,
    "msg": "system error",
    "time": 1637224716,
    "data": {
        ... ...
    }
}
```

{% endtab %}
{% endtabs %}

### Payment Flow <a href="#payment-flow" id="payment-flow"></a>

{% hint style="warning" %}
After successfully creating a CASH UPT payout order, call the [Payout Detail](https://docs.pagsmile.com/payout/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.
{% endhint %}

<figure><img src="/files/5AypTJsoqLqCCTXEcKrA" alt=""><figcaption></figcaption></figure>

## 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
}'
```

{% hint style="info" %}
Note:  ***94FAC\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*68548*** is Pagsmile's test App ID for sandbox, and ***d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302*** is authorization token associated with the test App ID.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pagsmile.com/payout/submit-a-payout/turkey/cash.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.