การโอนจ่าย (Pay-out · เปรู)

Disburse in Peru (PEN) to local bank accounts; see Payment methods. Send cashAccount, cashAccountType (CORRIENTE / AHORROS), cci (20 digits), paymentMethod, and receiver (name, email, phone, idType DNI / CE / PAS / RUC, identity). Amounts are integer céntimos (100 céntimos = 1.00 PEN).

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

Field	Required	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. PET −05: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	PEN only.
amount	M	Number	Integer céntimos.
paymentMethod	M	String	Bank code (e.g. BCP); Payment methods.
cashAccount	M	String(32)	Beneficiary account number (max 32).
cashAccountType	M	String(32)	CORRIENTE or AHORROS.
cci	M	String(20)	CCI — 20-digit interbank account code.
receiver	M	Object	Receiver Model.
name	M	String	Beneficiary full name (UTF-8).
email	M	String	Valid email.
phone	M	String	Contact phone (e.g. 51987654321).
idType	M	String	DNI, CE, PAS, or RUC.
identity	M	String	Document number.
callbackUrl	O	String(256)	Webhook URL; HTTP(S); max 256.

---

Example Body – Disbursement Request:

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

{
    "cashAccount": "12532481501",
    "cashAccountType": "CORRIENTE",
    "cci": "12345678901234567890",
    "receiver": {
        "idType": "DNI",
        "identity": "12345678909",
        "name": "Maria Rodriguez Lopez",
        "phone": "51987654321",
        "email": "[email protected]"
    },
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "amount": 20000,
        "currency": "PEN"
    },
    "orderNo": "2000102900000000000001",
    "paymentMethod": "BCP",
    "purpose": "Salary payment for March 2024"
}

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.
tradeNo	O	String	Platform trade ID.
status	O	String	Status Model.
disbursementTime	M	String	When disbursement was accepted (yyyy-MM-ddTHH:mm:ss±HH:mm).
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	Merchant account number when returned.
money	M	Object	Money Model.
currency	M	String	PEN.
amount	M	Number	Integer céntimos.
channel	M	Object	Channel Model.
paymentMethod	M	String	Echo bank code.
cashAccount	M	String	Echo cashAccount.
accountName	O	String	Beneficiary display name when returned.

Example Body – Disbursement Response:

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

{
  "code": "00",
  "message": "Successful",
  "orderNo": "2000102900000000000001",
  "tradeNo": "1522000109e998347483949",
  "status": "PROCESSING",
  "disbursementTime": "2024-12-17T10:55:00-05:00",
  "merchant": {
    "merchantId": "20001",
    "merchantName": "test",
    "accountNo": "2000124234782342"
  },
  "money": {
    "currency": "PEN",
    "amount": 20000
  },
  "channel": {
    "paymentMethod": "BCP",
    "cashAccount": "12532481501",
    "accountName": "Maria Rodriguez Lopez"
  }
}

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 payout request.
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	Settled bank code.
transactionTime	M	String	Completion time.
money	M	Object	Final amount; Money Model.
currency	M	String	PEN.
amount	M	Number	Integer céntimos. Note: may differ from the request for fees/partials—reconcile on tradeNo.
status	M	String	Status Model.

Return

Important

Respond with the string SUCCESS only.

{
  "orderNo": "2000102900000000000001",
  "tradeNo": "1522000109e998347483949",
  "merchantId": "20001",
  "merchantName": "test",
  "subMerchantId": "",
  "subMerchantName": "",
  "paymentMethod": "BCP",
  "transactionTime": "2024-12-17T10:55:00-05:00",
  "money": {
    "currency": "PEN",
    "amount": 20000
  },
  "status": "SUCCESS"
}

SUCCESS