Skip to main content

Api Payin

smilepayz teamsAbout 3 min

Request

The term refers to an application programming interface (API) that facilitates "pay-in" transactions.
This can include a variety of payment methods sources such as

bank transfers
qris
e-wallets
credit card payments
other digital

Request Path:

{Base URL}/v2.0/transaction/pay-in

Header Parameters

FieldAttributeTypeDescription
Content-TypeMStringapplication/json
X-TIMESTAMPMStringyyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00
X-SIGNATUREMStringFocus:How to signature
X-PARTNER-IDMStringmerchant ID

Body Parameters

FieldAttributeTypeDescription
orderNoMString(32)unique no. Focus OrderNumber Rule
purposeMString(64)purpose
merchantMObjectModel Object Merchant
moneyMObjectModel Object Money
areaMNumberFixed Value: 10
payerCObjectModel Object Payer
paymentMethodOStringModel Object PaymentMethod
productDetailOString(128)production description
expiryPeriodONumberexpiryPeriod (second); default:3600
redirectUrlOString(256)Redirect to customer url
callbackUrlOString(256)notify address
  1. If paymentMethod not pass. smilepayz will return a checkout page
  2. If paymentMethod is OVO. you can pass the payer phone.

Example Body – Transaction Request:


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

Response

HTTP Request

FieldAttributeTypeDescription
Content-TypeMStringapplication/json
X-TIMESTAMPMStringyyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00

Body Parameters

FieldAttributeTypeDescription
codeMStringsuccess = "00"
messageMStringresponse message
orderNoMStringtransaction unique no
merchantMObjectModel Object Merchant
transactionTimeMStringyyyy-MM-ddTHH:mm:ss+07:00 eg: 2020-12-17T10:55:00+07:00
moneyMObjectModel Object Money
channelMObjectchannel information Channel
tradeNoOStringsmilepayz orderNo
statusOStringModel Object Status
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

Notification

HTTP Request

FieldAttributeTypeDescription
Content-TypeMStringapplication/json
X-TIMESTAMPMStringyyyy-MM-ddTHH:mm:ss[zoneOffset] eg: 2020-12-17T10:55:00+07:00
X-SIGNATUREMStringhow to check this value

Body Parameters

FieldAttributeTypeDescription
orderNoMStringmerchant transaction unique no
tradeNoMStringsmilepayz trade no.
merchantIdMStringmerchant id
merchantNameMStringmerchant name
subMerchantIdOStringsub merchant id
subMerchantNameOStringsub merchant name
paymentMethodMStringpayment method. eg:BCA
transactionTimeMStringyyyy-MM-ddTHH:mm:ss
statusMStringModel Object Status
moneyMObjectModel Object Money
payerOStringModel Object Payer

Return

Important

Notification please return only string SUCCESS

{
  "merchantId": "20001",
  "merchantName": "test",
  "money": {
    "amount": 100000,
    "currency": "IDR"
  },
  "orderNo": "2000102900000000000001",
  "status": "SUCCESS",
  "tradeNo": "101200012410241325417215",
  "transactionTime": "2020-12-17T10:55:00+07:00"
}
Last update: