# Pay In

# Request address

Environment	address
Test Environment	http://8.130.9.219:8899/api/supefina/transactions/payin
formal environment	https://api.supefina.net/api/supefina/transactions/payin

# Submission Method

submit by POST

# Request parameters-Mexico

Header

Variable name	sample value
Content-Type	application/json

Body

Field name	variable name	required	type	description	sample value
Country number	countryId	Yes	String		- MEX: Mexico
order amount	orderAmount	yes	String	- input 100 to 100 MXN - when you specify the maximum or minimum order amount, the order amount must also be specified within the interval amount. - When the maximum or minimum order amount is passed in, the interval amount is used for verification.
minimum order amount	minOrderAmount	no	String	- Input 100 to 100 MXN
maximum order amount	maxOrderAmount	no	String	- input 100 to 100 MXN
duplicate payment	repeat	yes	Boolean	whether duplicate payment is supported (mainly for Mexico clabe)
payment Products	payProduct	yes	String		- ~~13: User free option ~~ - 15: Clabe
merchant number	merId	yes	String
currency	currency	no	String		- MXN: Mexican peso
customer name	customerName	no	String
customer mailbox	customerEmail	no	String
customer phone number	customerPhone	no	String
downstream merchant order number	merOrderNo	yes	String
order description	description	yes	String	it cannot contain special symbols.
customer Identification Number	customerIdentification	yes	String	ID number or identity certificate
customer Identification number type	customerIdentificationType	no	String
signature	sign	yes	String
application subject name	appName	no	String
random string	nonceStr	yes	String	the length of the random string cannot exceed 32.
additional transaction parameters	requestData	no	JSONObject	This field is a json object. You do not need to pass null or null"
company name	companyName	no	String
beneficiary	beneficiary	no	String
callback address	callbackUrl	no	String	for more information, see notification callback-API"

# Sample requests-Mexico

{
    "countryId": "MEX",
    "currency": "MXN",
    "orderAmount": "100",
    "payProduct": "15",
    "merId": "8102000000420042",
    "userIdentification": "testid123456",
    "description": "transas12121dasdasda",
    "sign": "F30BB4E4B31DE055F53A8A53DD5121E2",
    "repeat": true,
    "merOrderNo": "123123",
    "nonceStr": "123123",
    "companyName": "公司名称",
    "beneficiary": "受益人",
    "customerIdentification": "659423028000000007"
}

# Request parameters-Colombia

Header

Variable name	Sample value
Content-Type	application/json

Body

Field name	variable name	required	type	description	sample value
Country number	countryId	Yes	String		- COL: Colombia
order amount	orderAmount	yes	String
payment Products	payProduct	yes	String		08
merchant number	merId	yes	String
currency	currency	yes	String		- COP: Colombian peso
customer name	customerName	yes	String
customer's surname	lastName	no	String
customer mailbox	customerEmail	yes	String
customer phone number	customerPhone	yes	String
downstream merchant order number	merOrderNo	yes	String
order description	description	no	String
customer Identification Number	customerIdentification	yes	String	ID number or identity certificate
customer Identification number type	customerIdentificationType	no	String
signature	sign	yes	String
random string	nonceStr	yes	String	the length of the random string cannot exceed 32.
additional transaction parameters	requestData	no	JSONObject	This field is a json object. You do not need to pass null or null"
customer Account	customerAccount	required when the payment product is "08"	String
callback address	callbackUrl	no	String	for more information, see notification callback-API"

# Request example-Colombia

# Request parameters-Peru

Header

Variable name	sample value
Content-Type	application/json

Body

Field name	variable name	required	type	description	sample value
Country number	countryId	Yes	String		- PER: Peru
order amount	orderAmount	yes	String
payment Products	payProduct	yes	String
merchant number	merId	yes	String
currency	currency	yes	String
customer name	customerName	yes	String
customer's surname	lastName	yes	String
customer mailbox	customerEmail	yes	String
customer phone number	customerPhone	no	String
downstream merchant order number	merOrderNo	yes	String
order description	description	no	String
customer Identification Number	customerIdentification	yes	String	ID number or identity certificate
customer Identification number type	customerIdentificationType	yes	String
signature	sign	yes	String
application subject name	appName	no	String
random string	nonceStr	yes	String	the length of the random string cannot exceed 32.
additional transaction parameters	requestData	no	JSONObject	This field is a json object. You do not need to pass null or null"
customer Account	customerAccount	no	String
company name	companyName	no	String
beneficiary	beneficiary	no	String
callback address	callbackUrl	no	String	for more information, see notification callback-API"

# Response

Field name	variable name	type	description	sample value
response encoding	code	String
response Information	msg	String
response Data	data
merchant number	merCode	String
random string	nonceStr	String
merchant order number	merOrderNo	String
supefina order number	supefinaOrderNo	String
order amount	amount	BigDecimal
handling Fee	fee	BigDecimal
transaction Status		transactionStatus		- String - ~~00: pre-order ~~ - ~~01: The transaction is successful. ~~ - ~~02: transaction failed ~~ - 03: Payment rejection
04: failed to place an order	transaction link	url
String	payment Reference	reference
String	payment reference identifier	identifier	String

← Guide Pay Out →