BankTransfer

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

Submit a payout by Bank Transfer in Peru.

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

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

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
phone	string	Beneficiary's phone - 0 ~ 15 digits -
email	string	Beneficiary's email
bank_code*	string	Bank code, see bank list​
account*	string	Account - 20 digits -
account_type*	string	Should be one of CHECKING, SAVINGS.
document_id*	string	Beneficiary document id
document_type*	string	Beneficiary document type, should be one of DNI, RUC, PAS, CE.
fee_bear*	string	One of [beneficiary | merchant]
custom_code*	string	Merchant's order id. - Max.50 -
method*	string	Fixed Value: BankTransfer
country*	string	Fixed value: PER, for Peru
additional_remark*	string	Additional Remark - Max Length: 40 -
notify_url*	string	Where pagsmile will callback to
arrival_currency*	string	Beneficiary's account currency. - Fixed Value: PEN -
source_currency*	string	Merchant's account currency - supported: USD, GBP, EUR, PEN -
amount_type	string	Specify the amount value is fixed for merchant or beneficiary - One of: source_amount, arrival_amount(default) -
amount*	string	Payout amount - Min 0.01, Max 500,000 -
region*	string	@See Regions in Peru

200: OK success

{
    "code": 200,
    "msg": "success",
    "time": 1628580845,
    "data": {
        "id": "TS202108100734054iRiUZFPXfQBPE",
        "custom_code": "custom_code9982674851738108",
        "arrival_amount": "100",
        "arrival_currency": "PEN",
        "source_amount": "0.07",
        "source_currency": "USD",
        "status": "IN_PROCESSING"
    }
}

400: Bad Request bad request

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

401: Unauthorized unauthorized

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

500: Internal Server Error system error

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

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": {
        ... ...
    }
}

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" : "468****068",
      "email" : "g******[email protected]",
    * "bank_code": "0001", // Banco Continental
    * "account" : "00219400254640654321", // just for test in sandbox
    * "account_type" : "CHECKING",
    * "document_id" : "123456789", // just for test in sandbox, don't use this in production.
    * "document_type" : "PAS",
    * "method" : "BankTransfer",
    * "custom_code" : "custom_code9982674851738108",
    * "fee_bear" : "merchant",
    * "amount" : "100", 
    * "source_currency" : "PEN",
    * "arrival_currency" : "PEN",
    * "notify_url" : "https://notify.url",
    * "additional_remark" : "pagsmile payout test",
    * "country": "PER",
    * "region": "Amazonas"
}'

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

Example of Document

Document Type	Document	Description
DNI	0******6	8 digits
RUC	1********8	11 digits
PAS	2********9	7 - 12 digits
CE	3********9	8 - 12 digits

Example of Account

Currently, 10 to 20-digit bank account numbers are still supported. But eventually, only 20-digit CCI account codes will be supported.

Bank	Bank Code	Description
Any bank or financial institution	Any bank or financial institution	20-digit CCI interbank account code