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

document_type*

String

Beneficiary's identification type.

- Fixed: CI -

document_id*

String

Beneficiary's identification number. - 9 - 11 digits -

name*

String

Beneficiary's name - Length must between 5 and 100 -

country*

String

Fix value: CRI, for Costa Rica

method*

String

Fixed value: BANKTRANSFER

account_type*

String

Beneficiary's Account Type

- One of: SAVINGS, CHEKCING -

account*

String

Beneficiary's Bank Account

- 22 chars -

bank_code*

String

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: CRC

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 800, Max 10,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 -

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

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

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

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

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

{
    "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",
    * "bank_code": "0152",
    * "account_type": "CHECKING", // should be one of SAVINGS, CHECKING
    * "account": "CR9**********65",
    * "document_id": "20*****07",
    * "document_type": "CI",  // fixed value: CI
    * "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

9~11

114712748

Cedula de Identidad

Example of Account

Account Type

Length

Format

Example

CHECKING/SAVINGS

Alphanumeric

CR04011400007316288640

PreviousCosta Rica NextEcuador

Last updated 6 months ago

Was this helpful?

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

document_type*

String

Beneficiary's identification type.

- Fixed: CI -

document_id*

String

Beneficiary's identification number. - 9 - 11 digits -

name*

String

Beneficiary's name - Length must between 5 and 100 -

country*

String

Fix value: CRI, for Costa Rica

method*

String

Fixed value: BANKTRANSFER

account_type*

String

Beneficiary's Account Type

- One of: SAVINGS, CHEKCING -

account*

String

Beneficiary's Bank Account

- 22 chars -

bank_code*

String

Bank Code in Costa Rica, see

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: CRC

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 800, Max 10,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 -

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

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

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

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

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

{
    "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",
    * "bank_code": "0152",
    * "account_type": "CHECKING", // should be one of SAVINGS, CHECKING
    * "account": "CR9**********65",
    * "document_id": "20*****07",
    * "document_type": "CI",  // fixed value: CI
    * "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
}
'