Customer Top Up

This section will explain how merchants can initiate customer top up using SNAP specification.

ServiceCode	Method	URL	Description
38	POST	/v1.0/emoney/topup	API Customer Top Up

Request

Header

The following table is a header of request parameter:

Field Name	Attrib.	Datatype	Description
Content-Type	M	String	Represent media type of request e.g “application/json”
Authorization	M		Bearer token obtained from Access Token API in the format Bearer
X-TIMESTAMP	M	String(25)	Client's current local time in “yyyy-MM-ddTHH:mm:ssTZD” format
X-SIGNATURE	M		See General API Symmetric Signature
X-PARTNER-ID	M		See Credential Exchange
X-EXTERNAL-ID	M	String(max 36), Numeric	Unique request reference number from partner. Must be unique.
CHANNEL-ID	M		See Credential Exchange

Body

The following table is a body of request parameter:

Field Name	Attrib.	Datatype	Description
partnerReferenceNo	M	String(64)	Transaction identifier on service consumer system Uniqueness checking will be done within 2 (two) months only. If the same `partnerReferenceNo` reused after 2 months, we will treat it as new request.
customerNumber	M	String(20)	Customer account number
customerName	M	String(100)	Customer account name
amount.value	M	String(16,2)	Net amount of the transaction. If it’s IDR, then the value includes 2 decimal digits. e.g. IDR 10.000, will be placed with 10000.00
amount.currency	M	String(3)	Currency (should always be IDR)
notes	M	String(50)	Remark/transaction description. Unique is encouraged. Previously remark could have been maximum 100 characters, under Open API it is restricted to maximum 50 characters.
additionalInfo.beneficiaryEmail	O	String(50)	Beneficiary email
additionalInfo.beneficiaryProvider	M	String(40)	Beneficiary provider, see Emoney Providers

Response

Header

The following table is a header of response parameter:

Field Name	Attrib.	Datatype	Description
X-TIMESTAMP	M	String(25)	“yyyy-MM-ddTHH:mm:ssTZD” format

Body

The following table is a body of response parameter:

Field Name	Attrib.	Datatype	Description
responseCode	M	String(7)	Response code
responseMessage	M	String(150)	Response description
referenceNo	C	String(64)	Transaction identifier on service provider system. Must be filled upon successful transaction
partnerReferenceNo	M	String(64)	Transaction identifier on service consumer system
customerNumber	O	String(32)	Customer account number

Sample

Request

The following section is a sample of request parameter:

curl --location --request POST 'https://merchants.midtrans.com/v1.0/emoney-topup \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxMmUzODE4Mi00YjIxLTQ0YWMtOTVkNi1mMjFhMjEwZmIxZTAiLCJjbGllbnRJZCI6IjY2ODA1MmUzNGYxOTRhYThiZTc5ZTE1YTIxZTRmYzJmIiwibmJmIjoxNjYzODQwNTU5LCJleHAiOjE2NjM4NDE0NTksImlhdCI6MTY2Mzg0MDU1OX0.fEr0vIbB2kY8alZ-SROl3ftAFbfRd0uU-lGq9XuFi8M' \
--header 'X-TIMESTAMP: 2022-03-04T08:02:09+07:00' \
--header 'X-SIGNATURE: yqmBXZ3yV6NPG1LtwXMm3quXzJMRX5Ms+r9ebc5xWIZGSKbZL3Oy871GHb7WQUucLa5nxN/HcnZYoNHc+KkWTQ==' \
--header 'X-PARTNER-ID: 668052e34f194aa8be79e15a21e4fc2f' \
--header 'X-EXTERNAL-ID: 91919644194391346361915387229113' \
--header 'CHANNEL-ID: 95221' \
--data-raw '{
   "partnerReferenceNo": "61945219227478976148442931867349",
   "customerNumber": "6281773628883",
   "customerName": "John Doe",
   "amount": { "value": "100000.00", "currency": "IDR” },
   "notes": "Payout April 17",
   "additionalInfo": {
       "beneficiaryEmail": "[email protected]",
       "beneficiaryProvider": "gopay"
   }
}'

Response

The following section is a sample of response parameter:

Content-Type : application/json
x-timestamp  : 2022-03-04T08:02:09+07:00
-------------------------------------------------------------------------------
{
   "responseCode": "2023800",
   "responseMessage": "Request In Progress",
   "referenceNo": "558rFI9lxMdQlOkm65",
   "partnerReferenceNo": "61945219227478976148442931867349",
   "customerNumber": "6281773628883"
}

Content-Type : application/json
x-timestamp  : 2022-03-04T08:02:09+07:00
-------------------------------------------------------------------------------
{"responseCode": "4003800", "responseMessage": "Bad Request. Beneficiary Account not found"}

Migration

Request

The following table is a comparison of request parameter:

Payouts non-SNAP-based (current)	Payouts SNAP-based	Description
	partnerReferenceNo	Transaction identifier on service consumer system
amount	amount.value	Net amount of the transaction. If it’s IDR then value includes 2 decimal digits. e.g. IDR 10.000, will be placed with 10000.00
	amount.currency	Currency (should always be IDR)
beneficiary_account	customerNumber	Customer account number
beneficiary_name	customerName	Customer account name
notes	notes	Remark/transaction description Previously remark could have been maximum 100 characters, under Open API it is restricted to maximum 50 characters.
beneficiary_bank	additionalInfo.beneficiaryProvider	Provider name used by the beneficiary
beneficiary_email	additionalInfo.beneficiaryEmail	Beneficiary email

Response

The following table is a comparison of response parameter:

Payouts non-SNAP-based (current)	Payouts SNAP-based	Description
status		Payout status
	responseCode	Response code
	responseMessage	Response description
reference_no	referenceNo	Transaction identifier on service provider system. Must be filled upon successful transaction
	partnerReferenceNo	Transaction identifier on service consumer system
	customerNumber	Customer account number

Response Codes

Payouts non-SNAP-based (current)	Payouts SNAP-based	Description
	2023800	Request In Progress
	4003801	Invalid Field Format [fieldName]
	4003802	Missing Mandatory Field [fieldName]
	4013800	Unauthorized
	4013801	Invalid Token (B2B)
	4093801	Duplicate partnerReferenceNo
	5003800	Internal Server Error

Notes:

If you received 5xx error during top up, please do status inquiry before recreating new top up request just to be sure we have not proceed the previous request.