Pay-in collection

Brazil region pay-in API (BRL). See Payment methods.

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 request body.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. Brazil BRT −03:00).
X-SIGNATURE	M	String	Signature of JSON body (see product Signature doc).
X-PARTNER-ID	M	String	Your merchantID

Body Parameters

Field	Required	Type	Description
orderNo	M	String(32)	Merchant-unique id
purpose	M	String(64)	Memo to payer
merchant	M	Object	Wraps merchantId and optional sub-merchant fields.
merchantId	M	String	Smilepayz merchantId for this call.
merchantName	O	String	Merchant display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Name for subMerchantId.
money	M	Object	Currency plus amount for this transaction.
currency	M	String	ISO currency code for this call.
amount	M	Number	Amount
payer	O	Object	pixType / pixAccount. Recommended.
pixType	O	String	Recommended. CPF or CNPJ when sent;
pixAccount	O	String	Recommended. Digits only, 11 (CPF) or 14 (CNPJ).
paymentMethod	M	String	See Payment methods doc.
expiryPeriod	O	Number	ExpiryPeriod, default 3600.
redirectUrl	O	String(256)	HTTPS post-pay return URL, max 256 chars.
callbackUrl	O	String(256)	HTTPS async status URL, max 256 chars.

---

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

{
    "orderNo": "20011db2773a6fb2542dfa5cb34c",
    "purpose": "Online order — São Paulo",
    "merchant": {
        "merchantId": "20011"
    },
    "money": {
        "currency": "BRL",
        "amount": 5000
    },
    "payer": {
        "pixType": "CPF",
        "pixAccount": "12345678901"
    },
    "paymentMethod": "PIX",
    "redirectUrl": "https://www.google.com/webhp"
}

Responses

HTTP Request

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

Body Parameters

Field	Required	Type	Description
code	M	String	00 success, other values error.
message	M	String	UTF-8 human-readable result line.
orderNo	M	String	Merchant-unique id
tradeNo	O	String	Smilepayz tradeNo for this order.
merchant	M	Object	Wraps merchantId and optional sub-merchant fields.
merchantId	M	String	Smilepayz merchantId for this call.
merchantName	O	String	Merchant display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Name for subMerchantId.
accountNo	O	String	Settlement accountNo if gateway returns it.
money	M	Object	Currency plus amount for this transaction.
currency	M	String	ISO currency code for this call.
amount	M	Number	Amount
transactionTime	M	String	yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. BRT −03:00).
channel	M	Object	Channel payload (paymentUrl, qrString, …).
paymentMethod	M	String	See Payment methods doc.
paymentUrl	M	String	Cashier URL to open for the payer.
qrString	O	String	PIX or channel copy-paste string if returned.
status	O	String	Order or payment status enum value.

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

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

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

Notification/Callback

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json response or callback body.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	Callback body signature (see Callback signature guide).

Body Parameters

Field	Required	Type	Description
orderNo	M	String	Merchant-unique id
tradeNo	M	String	Smilepayz tradeNo for this order.
merchantId	M	String	Smilepayz merchantId for this call.
merchantName	M	String	Merchant display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Name for subMerchantId.
paymentMethod	M	String	See Payment methods doc.
transactionTime	M	String	Format: yyyy-MM-ddTHH:mm:ss
status	M	String	Order or payment status enum value.
money	M	Object	Currency plus amount for this transaction.
currency	M	String	ISO currency code for this call.
amount	M	Number	Amount

Return

Important

Respond with the string SUCCESS only.

{
    "orderNo": "20011db2773a6fb2542dfa5cb34c",
    "tradeNo": "131200112412130836186234",
    "merchantId": "20011",
    "merchantName": "Smilepayz Demo Store",
    "subMerchantId": "",
    "subMerchantName": "",
    "paymentMethod": "PIX",
    "transactionTime": "2024-12-12T23:36:19-03:00",
    "status": "SUCCESS",
    "money": {
        "currency": "BRL",
        "amount": 5000
    }
}

SUCCESS