BankTransfer

How to use Bank Transfer to submit a payout in Uruguay.

Submit a payout by Bank Transfer in Uruguay.

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

This endpoint allows you to submit a payout by Bank Transfer in Uruguay.

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
document_type*	String	Beneficiary's identification type. - One of: CI, RUT -
document_id*	String	Beneficiary's identification number.
email*	String	Beneficiary's email
phone*	String	Beneficiary's phone - 0 ~ 15 digits -
name*	String	Beneficiary's name - Length must between 5 and 100 -
country*	String	Fix value: URY, for Uruguay
method*	String	Fixed value: BANKTRANSFER
account_type*	String	Beneficiary's Account Type - One of: SAVINGS, CHEKCING -
account*	String	Beneficiary's Bank Account - 2 ~ 14 digits -
bank_code*	String	Bank Code in Uruguay, see bank list
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	Fixed value: UYU
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 - Min 1, Max 1,000,000 -
fee_bear*	String	Processing fee charges 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": "0.51",
        "arrival_currency": "UYU",
        "source_amount": "0.07",
        "source_currency": "USD",
        "status": "IN_PROCESSING"
    }
}

400: Bad Request order already existed

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

401: Unauthorized unauthorized

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

500: Internal Server Error fee not configured

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

500: Internal Server Error balance insufficient

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

500: Internal Server Error system error

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

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",
    * "phone": "12******9",
    * "email": "[email protected]",
    * "bank_code": "1001",
    * "account_type": "CHECKING", // should be one of SAVINGS, CHECKING
    * "account": "6***8",
    * "document_id": "12*******91",
    * "document_type": "CI",  // should be one of CI, RUT
    * "source_currency": "USD", 
    * "arrival_currency": "UYU", // fixed value: UYU
    * "fee_bear": "merchant", // should be one of merchant, beneficiary
    * "method": "BANKTRANSFER", // fixed value: BANKTRANSFER
    * "amount": "1.80",
    * "notify_url": "https://notify.url",
    * "custom_code" : "custom_code9982674851738108",
    * "additional_remark": "pagsmile payout test remark",
    * "country": "URY"  // fixed value: URY
}
'

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

Example of Document

Document Type	Document	Description
CI	0******6	8 digits
RUT	2**********8	12 digits

Example of Account

Bank	Bank Code	Description
BROU	1001	14 digits
BHU	1091	10 digits
BANDES	1110	9 digits
ITAU	1113	7 digits
SCOTIABANK	1128	10 digits
SANTANDER	1137	12 digits
BBVA	1153	2 - 9 digits
HSBC	1157	10 digits
HERITAGE	1162	9 digits
CITIBANK	1205	10 digits
NACION	1246	12 digits
BAPRO	1361	7 digits
PREX (FORTEX)	7905	8 digits