Langsung ke konten utama

Pembayaran masuk (Pay-In · Meksiko)

Sekitar 4 menit

API pay-in wilayah Meksiko (MXN). Lihat 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

FieldRequiredTypeDescription
Content-TypeMStringapplication/json request body.
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. Mexico CST −06:00).
X-SIGNATUREMStringSignature of JSON body (see product Signature doc).
X-PARTNER-IDMStringYour merchantID

Body Parameters

FieldRequiredTypeDescription
orderNoMString(32)Merchant-unique id
purposeMString(64)Memo to payer
merchantMObjectWraps merchantId and optional sub-merchant fields.
    merchantIdMStringSmilepayz merchantId for this call.
    merchantNameOStringMerchant display name.
    subMerchantIdOStringSub-merchant ID.
    subMerchantNameOStringName for subMerchantId.
moneyMObjectCurrency plus amount for this transaction.
    currencyMStringFixed to MXN.
    amountMNumberAmount (maks. 2 desimal). Lihat Money
paymentMethodMStringSee Payment methods doc.
expiryPeriodONumberExpiryPeriod, default 3600.
redirectUrlOString(256)HTTPS post-pay return URL, max 256 chars.
callbackUrlOString(256)HTTPS async status URL, max 256 chars.

Example Body – Transaction Request:

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

Responses

HTTP Request

FieldRequiredTypeDescription
Content-TypeMStringapplication/json request body.
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

FieldRequiredTypeDescription
codeMString00 success, other values error.
messageMStringUTF-8 human-readable result line.
orderNoMStringMerchant-unique id
tradeNoOStringSmilepayz tradeNo for this order.
merchantMObjectWraps merchantId and optional sub-merchant fields.
    merchantIdMStringSmilepayz merchantId for this call.
    merchantNameOStringMerchant display name.
    subMerchantIdOStringSub-merchant ID.
    subMerchantNameOStringName for subMerchantId.
moneyMObjectCurrency plus amount for this transaction.
    currencyMStringFixed to MXN.
    amountMNumberAmount (maks. 2 desimal). Lihat Money
transactionTimeMStringyyyy-MM-ddTHH:mm:ss±HH:mm
channelMObjectChannel payload (paymentUrl, qrString, …).
    paymentMethodMStringSee Payment methods doc.
    paymentUrlOStringCashier URL to open for the payer.
    qrStringOStringPIX or channel copy-paste string if returned.
    receiverBankNameOStringBank / brand code when returned.
    vaNumberOStringVirtual account / reference when returned.
statusOStringOrder or payment status enum value.
responseCodeOStringChannel result code when returned (e.g. CODI / OXXO).
responseMessageOStringChannel result text when returned.
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-06:00

Sub-order transaction & callback

Untuk pay-in Meksiko (mis. SPEI), channel dapat mengkredit order merchant yang sama lebih dari sekali. Aturan platform:

  1. Create request hanya membuat order utama: /v1/pay tidak memecah sub-order di muka.
  2. Kredit sukses tambahan menjadi sub-order: setiap kredit tambahan yang dikenali mendapat tradeNo, jumlah, biaya, settlement, dan callback merchant sendiri.
  3. Arti field callback:
    • orderNo: selalu nomor order merchant asli (sama dengan order utama).
    • tradeNo: id platform untuk transaksi ini (order utama atau sub-order; masing-masing unik).
    • money.amount: jumlah kredit ini (jumlah sub-order bisa berbeda dari jumlah create).
  4. Idempotency: Anda mungkin menerima beberapa SUCCESS callback untuk satu orderNo. Gunakan tradeNo sebagai kunci idempotency tingkat transaksi; jangan dedupe hanya dengan orderNo.
  5. Order utama dan sub-order independen: jumlah sub-order tidak otomatis menandai order utama SUCCESS atau mengubah amount/status order utama. Lihat subOrderList di Inquiry Status.

Tips

Verifikasi signature dan balas teks SUCCESS untuk setiap callback order utama / sub-order.

Notification/Callback

Callback signature ≠ request signature

Jangan verifikasi X-SIGNATURE callback dengan formula request. Lihat Callback Signature.

HTTP Request

FieldRequiredTypeDescription
Content-TypeMStringapplication/json request body.
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATUREMStringLihat Callback Signature

Body Parameters

FieldRequiredTypeDescription
orderNoMStringMerchant-unique id. Callback order utama dan sub-order memakai orderNo merchant asli yang sama.
tradeNoMStringSmilepayz tradeNo untuk transaksi ini (order utama atau sub-order). Gunakan field ini untuk idempotency tingkat transaksi.
merchantIdMStringSmilepayz merchantId for this call.
merchantNameMStringMerchant display name.
subMerchantIdOStringSub-merchant ID.
subMerchantNameOStringName for subMerchantId.
paymentMethodMStringSee Payment methods doc.
transactionTimeMStringFormat: yyyy-MM-ddTHH:mm:ss
statusMStringOrder or payment status enum value.
moneyMObjectCurrency plus amount for this transaction.
    currencyMStringFixed to MXN.
    amountMNumberAmount untuk kredit ini (maks. 2 desimal). Sub-order memakai jumlah yang dikredit aktual. Lihat Money
payerOObjectPayer object per region rules (see Payer model).
    nameOStringBeneficiary full name (UTF-8).

Return

Important

Respond with the string SUCCESS only.

{
    "orderNo": "20001mxspei394eeb7b44c2460",
    "tradeNo": "141200112412131711531135",
    "merchantId": "20001",
    "merchantName": "Smilepayz Demo Store",
    "subMerchantId": "",
    "subMerchantName": "",
    "paymentMethod": "SPEI",
    "transactionTime": "2024-12-13T04:11:54-06:00",
    "status": "SUCCESS",
    "money": {
        "currency": "MXN",
        "amount": 250000
    },
    "payer": {
        "name": "Juan Carlos Hernández"
    }
}
Copyright © 2026 smilepayz teams