TransfersmileTransfersmile
  • EN
  • PT
  • ES
  • EN
  • PT
  • ES
  • Introduction
  • Payin API
    • Environments
    • Direct integration
      • Brazil
        • Credit Card
        • Pix
        • Lottery
        • Boleto
        • Deposit Express
        • Wallet
    • Notification
      • Security
    • Payin Detail
    • Refund
    • Plug-in & Tools
      • transfersmile JavaScript
      • transfersmile SDK
      • Get CreditCard Token
      • Supported Bank List Query
      • Installment Detail Query
    • Data
      • Payment Method
      • Data for test (Sandbox)
      • Payin Status
      • Icon of methods
    • API Code
  • Payout API
    • Environments
    • Security
    • Submit a payout
      • transfersmile Wallet
        • WebView Example
        • H5 Authorization
        • Native App Authorization
        • Send Prizes
      • Brazil
        • Pix
        • BankTransfer
    • Notification
    • Payout DryRun
    • Account Balance
    • Payout Status
    • Payout List
    • Payout Detail
    • Payment Method
    • Data for test
    • Bank Code
      • Bank in Brazil
    • API Code

Credit Card

How to use CreditCard to submit a payin in Brazil.

Post

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

Payin by CreditCard

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

Parameters

Header

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: CreditCard
order_currency*stringFixed value: BRL
order_amount*stringpayment amount
- 0.5~50000 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
user_ip*stringuser's IP address
token*stringuse transfersmile Javascript to get token
fingerprint*stringuse transfersmile Javascript to get fingerprint
issuer*stringissuer of CreditCard
installmentsstringinstallments for CreditCard
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_code*stringzip code
address.statestringstate
- Required if zip_code not provide -
address.citystringcity
- Required if zip_code not provide -
address.street_numberstringstreet number
- Required if zip_code not provide -
address.streetstringstreet
- Required if zip_code not provide -
website_urlstringmerchant website URL
- Max. 128 chars -
threeds.sli*stringSecurity level indicator
threeds.version*stringVersion used in the transaction
threeds.caav*stringAuthentication Value (CAVV / AAV for 3DS1) recieved from authorization/Authentication response
threeds.eci*stringECI value recieved from authorization/authentication response
threeds.server_trans_id*stringUniversally unique transaction identifier assigned by the 3DS Server to identify a single transaction generated by the Init 3DS API and used to link the init call to the order call
threeds.xid*stringA unique Visa or Amex transaction id
threeds.cvvstringCVV result
threeds.avsstringProcesor response code for AVS. Only required in cases where all AVS results (zipcode, street address, and name when available) arrive as one string
threeds.statusstring3DSecure - Status text received from 3D secure vendor
threeds.status_code*string3DSecure - Status code recieved from authorization/authentication response, (Possible values: U, N, Y, A, C, D, R, I)
threeds.status_reason_codestringString EMVCO Indicator of the reason for the 3DS status code provided during the authentication, (Possible values: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16)
threeds.liability_shiftstringliability shift - indicate whether the chargeback liability shifted to the card issuer

Responses

200submit successfully
{
    "code": "10000",
    "msg": "Success",
    "trade_no": "2022010110293900084",
    "out_trade_no": "202201010354003",
    "web_url": "",
    "trade_status": "PROCESSING"
}
400duplicate out_trade_no
{
    "code": "40002",
    "msg": "Business Failed",
    "sub_code": "duplicate-out_trade_no",
    "sub_msg": "out_trade_no is duplicate"
}

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": "CreditCard",
    * "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",
    * "user_ip":"127.0.0.1",
    * "token":"${token}",
    * "fingerprint":"${fingerprint}",
    * "issuer":"visa",
      "installments":"1",
    * "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"
      },
    * "address" : {
    *     "zip_code": "38082365"
      },
    * "threeds": {
    *     "sli": "",
    *     "version": "",
    *     "cavv": "",
    *     "eci": "",
    *     "server_trans_id": "",
    *     "xid": "",
          "cvv": "",
          "avs": "",
          "status": "",
    *     "status_code": "",
          "status_reason_code": "",
          "liability_shift": true
      }
      }'

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.

Next
Pix