Skip to main content

การโอนจ่าย (Pay-out · อินเดีย)

smilepayz teamsประมาณ 3 นาที

API Pay-out ภูมิภาค อินเดีย (INR). ดู Payment methods

Request

POST/v2.0/disbursement/pay-out

Request Path:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/disbursement/pay-out
production: https://gateway.smilepayz.com/v2.0/disbursement/pay-out

Header Parameters

FieldRequiredTypeDescription
Content-TypeMStringapplication/json request body.
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. IST +05:30).
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 INR.
    amountMNumberAmount
paymentMethodOString(6)See Payment methods doc.
cashAccountMString(32)Beneficiary bank account number.
ifscCodeMString(11)11-char IFSC (e.g. YESB0000097, HDFC0000001).
receiverMObjectBeneficiary object (see Receiver model).
    nameMStringBeneficiary full name (UTF-8).
callbackUrlOString(256)HTTPS async status URL, max 256 chars.

Example Body – Disbursement Request:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+05:30
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.
    accountNoOStringSettlement accountNo if gateway returns it.
moneyMObjectCurrency plus amount for this transaction.
    currencyMStringFixed to INR.
    amountMNumberAmount
disbursementTimeMStringFormat (yyyy-MM-ddTHH:mm:ss±HH:mm).
channelMObjectChannel payload (paymentUrl, qrString, …).
    paymentMethodMStringSee Payment methods doc.
    cashAccountMStringBeneficiary bank account number.
statusOStringOrder or payment status enum value.

Example Body – Disbursement Response:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+05:30

Notification/Callback

HTTP Request

FieldRequiredTypeDescription
Content-TypeMStringapplication/json request body.
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATUREMStringCallback body signature (see Callback signature guide).

Body Parameters

FieldRequiredTypeDescription
orderNoMStringMerchant-unique id
tradeNoMStringSmilepayz tradeNo for this order.
merchantIdMStringSmilepayz merchantId for this call.
merchantNameMStringMerchant display name.
subMerchantIdOStringSub-merchant ID.
subMerchantNameOStringName for subMerchantId.
paymentMethodMStringSee Payment methods doc.
transactionTimeMStringFormat: yyyy-MM-ddTHH:mm:ss
moneyMObjectCurrency plus amount for this transaction.
    currencyMStringFixed to INR.
    amountMNumberAmount
statusMStringOrder or payment status enum value.
utrCStringUTR when returned by bank.

Return

Important

Respond with the string SUCCESS only.

{
    "orderNo": "20001indpayout001234567890",
    "tradeNo": "122200192412131501111816",
    "merchantId": "20001",
    "merchantName": "Smilepayz Demo Store",
    "subMerchantId": "",
    "subMerchantName": "",
    "paymentMethod": "HDFC",
    "transactionTime": "2024-12-13T13:31:11+05:30",
    "money": {
        "currency": "INR",
        "amount": 100000
    },
    "status": "SUCCESS",
    "utr": "224015123456"
}