Pembayaran masuk (Pay-In · Brasil)

Pay-in merchant di Brasil (BRL) dengan PIX; lihat Payment methods. Kirim payer.pixAccount (CPF atau CNPJ) dan paymentMethod: PIX.

Request

POST/v2.0/transaction/pay-in

Request Path:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/transaction/pay-in
production: https://gateway.smilepayz.com/v2.0/transaction/pay-in

Header Parameters

Field	Required	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. Brazil BRT −03:00).
X-SIGNATURE	M	String	Request signature; Signature Generation.
X-PARTNER-ID	M	String	merchantID (alphanumeric).

Body Parameters

Field	Required	Type	Description
orderNo	M	String(32)	6–32 alphanumeric; unique per merchant.
purpose	M	String(64)	UTF-8; length 1–64.
merchant	M	Object	Merchant routing and settlement.
merchantId	M	String	Platform merchant ID.
merchantName	O	String	UTF-8 display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Sub-merchant name (UTF-8).
money	M	Object	Amount and currency.
currency	M	String	BRL only.
amount	M	Number	Integer centavos (e.g. 20000 = BRL 200.00).
payer	M	Object	Payer Model.
pixAccount	M	String	CPF (11 digits) or CNPJ (14 digits), digits only.
paymentMethod	M	String	PIX; Payment methods.
expiryPeriod	O	Number	Session TTL (seconds); default 3600; range 3600–86400.
redirectUrl	O	String(256)	Post-pay redirect URL; HTTP(S); max 256.
callbackUrl	O	String(256)	Status webhook URL; HTTP(S); max 256.

---

Example Body – Transaction Request:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-03:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
    "merchant": {
        "merchantId": "20011"
    },
    "payer": {
        "pixAccount": "48982488880"
    },
    "money": {
      "amount": 20000,
        "currency": "BRL"
    },
    "orderNo": "200110edbb466abb04682968b40",
    "paymentMethod": "PIX",
    "purpose": "Purpose For Transaction from Java SDK",
    "redirectUrl": "https://www.google.com/webhp"
}

Responses

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

Field	Required	Type	Description
code	M	String	00 = success; other codes = error.
message	M	String	Result text (UTF-8).
orderNo	M	String	Echo of orderNo.
merchant	M	Object	Merchant Model.
merchantId	M	String	Merchant ID.
merchantName	O	String	Display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Sub-merchant name.
accountNo	O	String	Settlement account when returned.
money	M	Object	Money Model.
currency	M	String	BRL.
amount	M	Number	Integer centavos.
transactionTime	M	String	yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. BRT −03:00).
channel	M	Object	Channel Model.
paymentMethod	M	String	PIX.
paymentUrl	M	String	Cashier URL for the payer.
qrString	O	String	PIX copy-and-paste / QR payload when returned.
additionalInfo	O	Object	Extra channel data (e.g. alternate paymentUrl in web flows).
tradeNo	O	String	Platform trade ID.
status	O	String	Status Model.

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-03:00

{
    "channel": {
        "additionalInfo": {},
        "paymentMethod": "PIX",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=131200112412130836186234",
        "qrString": "00020101021226800014br.gov.bcb.pix2558pix.delbank.com.br/v2/cob/vcharge1f6aed0623644c24bbdc174ce5204000053039865802BR5907DELBANK6007ARACAJU62070503***6304BC39"
    },
    "code": "00",
    "merchant": {
        "accountNo": "11320011202402290943",
        "merchantId": "20011",
        "merchantName": "bradytest123www"
    },
    "message": "Successful",
    "money": {
      "amount": 20000,
        "currency": "BRL"
    },
    "orderNo": "20011db2773a6fb2542dfa5cb34c",
    "status": "PROCESSING",
    "tradeNo": "131200112412130836186234",
    "transactionTime": "2024-12-12T23:36:19-03:00"
}

{
    "channel": {
        "additionalInfo": {
            "paymentUrl": "https://gateway.smilepayz.com/cashier/#/transfer"
        },        
        "paymentMethod": "PIX",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=131200112412130836186234",
        "qrString": ""
    },
    "code": "00",
    "merchant": {
        "accountNo": "11320011202402290943",
        "merchantId": "20011",
        "merchantName": "bradytest123www"
    },
    "message": "Successful",
    "money": {
      "amount": 20000,
        "currency": "BRL"
    },
    "orderNo": "20011db2773a6fb2542dfa5cb34c",
    "status": "PROCESSING",
    "tradeNo": "131200112412130836186234",
    "transactionTime": "2024-12-12T23:36:19-03:00"
}

Notification/Callback

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	Callback signature; verify.

Body Parameters

Field	Required	Type	Description
orderNo	M	String	Same orderNo as pay-in.
tradeNo	M	String	Platform tradeNo.
merchantId	M	String	Merchant ID.
merchantName	M	String	Display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Sub-merchant name.
paymentMethod	M	String	PIX.
transactionTime	M	String	Completion time (yyyy-MM-ddTHH:mm:ss±HH:mm or without offset per channel).
status	M	String	Status Model.
money	M	Object	Final amount; Money Model.
currency	M	String	BRL.
amount	M	Number	Integer centavos. Note: notification amount may differ from the original request; use it for reconciliation.

Return

Important

Respond with the string SUCCESS only.

{
  "orderNo": "2000102900000000000001",
  "tradeNo": "101200012410241325417215",
  "merchantId": "20001",
  "merchantName": "test",
  "subMerchantId": "",
  "subMerchantName": "",
  "paymentMethod": "PIX",
  "transactionTime": "2024-12-17T10:55:00",
  "money": {
    "currency": "BRL",
    "amount": 100000
  },
  "status": "SUCCESS"
}

SUCCESS