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

Payin Detail

Request Base URL

Test Environment : https://gateway-test.transfersmile.com

Prod Environment : https://gateway.transfersmile.com

EndPoints

/trade/query

Request Header

ParameterRequiredDescription
Content-Typerecommendapplication/json
AuthorizationyesBasic Base64(app_id:security_key)

Request Body (JSON format)

ParameterTypeRequiredMax Length(or Default Value)Description
app_idstringyes32created app's id at dashboard
timestampstringyes19yyyy-MM-dd HH:mm:ss
out_trade_nostringyes64Merchant's trade NO.(cannot be empty with trade_no at same time)
trade_nostringyes64transfersmile trade NO.(cannot be empty with out_trade_no at same time)

Request Sample

curl --location --request POST 'https://gateway.transfersmile.com/trade/query' \
--header 'Authorization: Basic Base64(appid:security_key)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "app_id": "app_id",
    "timestamp": "{{datetime}}",
    "out_trade_no": "{{out_trade_no}}",
    "trade_no": "{{trade_no}}"
}'

Http Response (JSON format)

ParameterTypeDescription
codestringreturn code
msgstringreturn msg
out_trade_nostringmerchant's trade NO.
trade_nostringtransfersmile's trade NO.
trade_statusstringstatus
order_amountdecimalamount
order_currencystringcurrency
create_timestringyyyy-MM-dd HH:mm:ss[UTC]
update_timestringyyyy-MM-dd HH:mm:ss[UTC]
refuse_detailstringRefuse only
customer.identify.typestring​
customer.identify.numberstring​
customer.emailstring​
customer.phonestring​

Return Code (Success)

{
  "code": "10000",
  "msg": "Success",
  "trade_no": "",
  "out_trade_no": "",
  "trade_status": "",
  "order_currency": "",
  "order_amount": "",
  "customer": {
      "identify": {
          "number": "",
          "type": ""
      },
      "email": "",
      "phone": ""
  },
  "refuse_detail": "",
  "create_time": "",
  "update_time": ""
}

Return Code (Fail)

{
  "code": "40002",
  "msg": "Business Failed",
  "sub_code": "invalid-signature",
  "sub_msg": "invalid signature"
}
Prev
Notification
Next
Refund