# Bre-B

## Submit a payout by Bre-B in Colombia

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

This endpoint allows you to submit a payout by Bre-B in Colombia.

#### 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 | Beneficiary's full name, must match the name on the document id. Length must between 5 and 100.                              |
| account<mark style="color:red;">\*</mark>            | string | <p>Account</p><p>- Support Email, Phone, Document Id and Alias, Max 64 -</p>                                                 |
| document\_id<mark style="color:red;">\*</mark>       | string | Beneficiary document id                                                                                                      |
| document\_type<mark style="color:red;">\*</mark>     | string | Beneficiary [***document type***](#document-type), should be one of CC, CE, PEP, NIT, TI, PAS                                |
| method<mark style="color:red;">\*</mark>             | string | Fixed Value: Bre-B                                                                                                           |
| custom\_code<mark style="color:red;">\*</mark>       | string | <p>Merchant's order id</p><p>- Max.50 -</p>                                                                                  |
| fee\_bear<mark style="color:red;">\*</mark>          | string | <p>All fees charge to merchant or beneficiary<br>- One of: merchant, beneficiary -</p>                                       |
| amount<mark style="color:red;">\*</mark>             | string | <p>Payout amount, should be an Integer.</p><p>- Min 1000, Max 11,550,000 -</p>                                               |
| amount\_type                                         | string | <p>Specify the amount value is fixed for merchant or beneficiary<br>- One of: source\_amount, arrival\_amount(default) -</p> |
| source\_currency<mark style="color:red;">\*</mark>   | string | <p>Merchant's account currency</p><p>-  supported: USD, GBP, EUR, COP -</p>                                                  |
| arrival\_currency<mark style="color:red;">\*</mark>  | string | <p>Beneficiary's account currency.</p><p>- Fixed Value: COP -</p>                                                            |
| notify\_url<mark style="color:red;">\*</mark>        | string | Where pagsmile will callback to                                                                                              |
| additional\_remark<mark style="color:red;">\*</mark> | string | <p>Additional Remark<br>- Max Length: 40 - </p>                                                                              |
| country<mark style="color:red;">\*</mark>            | string | Fixed value: COL, for Colombia                                                                                               |

{% tabs %}
{% tab title="200: OK success" %}

```javascript
{
    "code": 200,
    "msg": "success",
    "time": 1628580845,
    "data": {
        "id": "TS202108100734054iRiUZFPXfQBC",
        "custom_code": "custom_code9982674851738108",
        "arrival_amount": "1000",
        "arrival_currency": "COL",
        "source_amount": "1000",
        "source_currency": "COL",
        "status": "IN_PROCESSING"
    }
}
```

{% endtab %}

{% tab title="400: Bad Request bad request" %}

```javascript
{
    "code": 4001000,
    "msg": "invalid parameter",
    "time": 1637224716,
    "data": {
        "err": "error detail message"
    }
}
```

{% endtab %}

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

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

{% endtab %}

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

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

{% endtab %}

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

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

{% endtab %}

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

```javascript
{
    "code": 5001000,
    "msg": "system error",
    "time": 1637224716,
    "data": {
        "err": "error detail message"
    }
}
```

{% endtab %}
{% endtabs %}

## 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": "SU**********EZ",
    * "account": "su**********com",
    * "document_id": "10******58",
    * "document_type": "CC",
    * "method": "Bre-B",
    * "custom_code": "custom_code9982674851738108",
    * "fee_bear": "merchant",
    * "amount": "1000", //Amount must be an integer, the fraction is not supported (e.g. 100 or 100.00 is acceptable, but 100.01 is not)
    * "source_currency": "COP",
    * "arrival_currency": "COP",
    * "notify_url": "https://notify.url",
    * "additional_remark": "pagsmile payout test",
    * "country": "COL"
}'
```

{% 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 %}

## Document Type

| Name | Explanation                         | Length          | Type       |
| ---- | ----------------------------------- | --------------- | ---------- |
| CC   | Cédula de Ciudadanía                | Between 6 to 10 | numeric    |
| CE   | Cédula de Extranjería               | up to 12        | characters |
| PEP  | Permiso Especial de Permanencia     | up to 15        | numeric    |
| TI   | Tarjeta de Identidad                | 6 to 10         | numeric    |
| NIT  | Número de Identificación Tributaria | 9 to 10         | numeric    |
| PAS  | Pasaporte                           | up to 9         | numeric    |