BankTransfer

How to use Bank Transfer to submit a payout in Costa Rica.

Submit a payout by Bank Transfer in Costa Rica.

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

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

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
method*	String	Fixed value: BANKTRANSFER
name*	String	Beneficiary's name - Length must between 5 and 100 -
document_type*	String	Beneficiary's identification type. - CI or DIMEX -
document_id*	String	Beneficiary's identification number. - CI: 9 - 11 digits, DIMEX: 11 - 12 digits -
bank_code*	String	Bank Code in Costa Rica, see bank list
account*	String	Beneficiary's Bank Account - 22 chars -
account_type	String	Beneficiary's Account Type - One of: SAVINGS, CHEKCING -
notify_url*	String	Where pagsmile will send notifications to.
source_currency*	String	Merchant Account Currency - One of: USD, EUR, GBP -
arrival_currency*	String	Fixed value: CRC
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 600, Max 1,000,000 -
fee_bear*	String	All fees charge to merchant or beneficiary - One of: merchant, beneficiary -
custom_code*	String	Merchant Payout ID - Max. 50 chars -
country*	String	Fix value: CRI, for Costa Rica
additional_remark*	String	The descriptor on the user's bank bill - Max. 40 chars -

200: OK submit successfully

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

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",
     "bank_code": "152",
      "account_type": "CHECKING", // one of SAVINGS, CHECKING
     "account": "CR9**********65",
     "document_id": "20*****07",
     "document_type": "CI",  // CI or DIMEX
     "source_currency": "USD", 
     "arrival_currency": "CRC", // fixed value: CRC
     "fee_bear": "merchant", // should be one of merchant, beneficiary
     "method": "BANKTRANSFER", // fixed value: BANKTRANSFER
     "amount": "1000.00",
     "notify_url": "https://notify.url",
     "custom_code" : "custom_code9982674851738108",
     "additional_remark": "pagsmile payout test remark",
     "country": "CRI"  // fixed value: CRI
}
'

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	Length	Document	Description
CI	9~11	114712748	Cedula de Identidad
DIMEX	11~12		Documento de Identidad Migratorio para Extranjero

Example of Account

Account Type	Length	Format	Example
CHECKING/SAVINGS	22	Alphanumeric	CR04011400007316288640