Deposit Express

How to use Boleto to submit a payin in Brazil.

Post

https://gateway-test.transfersmile.com/trade/pay

Payin by Deposit Express

This endpoint allows you to submit a payin by Deposit Express in Brazil.

Parameters

Content-Type*stringapplication/json; chartset=UTF-8
Authorization*stringBasic Base($app_id:$security_key)

Body

app_id*stringcreated app's id at dashboard
- Max. 32 chars -
timestamp*stringyyyy-MM-dd HH:mm:ss
- Max. 19 chars -
out_trade_no*stringID given by the merchant in their system
- Max. 64 chars -
method*stringFixed value: DepositExpress
bank*stringBank code
- One of: itau, santander, bradesco, caixa （caixa not work in test environment) -
order_currency*stringFixed value: BRL
order_amount*stringpayment amount
- 1~50,000 BRL -
subject*stringpayment reason or item title
- Max. 128 chars -
content*stringpayment reason detail or item detail.This will be shown on the bank bill.
- Max. 255 chars -
notify_url*stringWhere transfersmile will send notification to
return_urlstringRedirect to Merchant's url when user finished checkout
buyer_id*stringmerchant user's id
customer.name*stringUser's name
customer.phone*stringUser's phone
customer.email*stringUser's email
customer.identify.number*stringUser's identification number;
- 11 digits if CPF or 14 digits if CNPJ -
customer.identify.type*stringUser's identification type;
- CPF or CNPJ -
address.zip_codestringzip code
address.statestringstate
address.citystringcity
address.street_numberstringstreet number
address.streetstringstreet
website_urlstringmerchant website URL
- Max. 128 chars -

Responses

200submit successfully
{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022021810560500094",
    "out_trade_no": "202201010354003",
    "web_url": "https://checkout-testv2.transfersmile.com/checkout?prepay_id=Um1RbHBsVENReWlLdWJXSzFDbEFTemtCYjN5S1JUUWJwbEtndFhWSGJ1dz0=-8357Fae6",
    "pay_url": "https://checkout-testv2.transfersmile.com/checkout?prepay_id=Um1RbHBsVENReWlLdWJXSzFDbEFTemtCYjN5S1JUUWJwbEtndFhWSGJ1dz0=-8357Fae6",
    "trade_status": "PROCESSING",
    "provider_owner": "transfersmile Brasil",
    "provider_owner_document": "23.010.551/0001­-31",
    "provider_agency": "7307",
    "provider_number": "41531-0",
    "bank_name": "itau"
}
400duplicate out_trade_no
{
    "code": "40002",
    "msg": "Business Failed",
    "sub_code": "duplicate-out_trade_no",
    "sub_msg": "out_trade_no is duplicate"
}

Tip

User payment tips

  • Users need to use the complete bank account information of transfersmile to finish the payment. Including provider_agency (bank agency), provider_number (bank account number), bank_name , provider_owner_document (transfersmile CNPJ)

  • pay_url is the page for users to submit the proof of payment to transfersmile. In addition, an email should be sent to users with the link for submission.

  • Users must submit the proof of payment for processing the payment..

Example

curl --location --request POST 'https://gateway-test.transfersmile.com/trade/pay' \
--header 'Authorization: Basic MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "app_id": "162************38",
    * "out_trade_no": "202201010354003",
    * "method": "DepositExpress",
    * "bank": "itau",
    * "order_amount": "12.01",
    * "order_currency": "BRL",
    * "subject": "trade pay test",
    * "content": "trade pay test conent",
    * "notify_url": "http://merchant/callback/success",
      "return_url": "https://www.merchant.com",
    * "buyer_id": "buyer_0101_0001",
    * "timestamp": "2022-01-01 03:54:01",
      "timeout_express":"1c",
    * "customer" : {
    *     "identify": {
    *         "type": "CPF",
    *         "number": "50284414727"
          },
    *     "name": "Test User Name",
    *     "email": "[email protected]",
    *     "phone": "75991435892"
      }
      }'

Example of payment page

Tip

Note: 162********38 is transfersmile's test app id for sandbox, and MTYyNTgyOTIxNDUzMTY2Mzg6UGFnc21pbGVfc2tfZDUwMWQ1ZGNkNTI5OGQ5N2MwNmUzYjI4YjA2OWZjZmY3NDU5ZjY2NzNiMjFjMTFlYTY3NDM5MDgzOTZkOTYxNQ== is authorization token associated with the test app id.

Warning

Please use your own app_id and generate your own authorization token when testing.