Supefina API Documentation

# Pay Out

# Request address

environment address
test Environment http://8.130.9.219: 8899/api/supefina/transactions/payout
formal environment https://api.supefina.net/api/supefina/transactions/payout

# 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.

payment Products payProduct yes String
- 15: Clabe
- 16: bank card
merchant number merId yes String

currency currency yes String
- MXN: Mexican peso
customer mailbox customerEmail no String

customer phone number customerPhone no String

downstream merchant order number merOrderNo yes String

account account yes String

payee's bank number bankId yes String see download> Bank code"
customer name customerName yes String

customer address customerAddress no String

customer Identification Number customerIdentification no String ID number or identity certificate
customer Identification number type customerIdentificationType no String

order description description yes String it cannot contain special symbols.
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"
callback address callbackUrl no String for more information, see notification callback-API"

# Sample requests-Mexico

{
    "countryId": "MEX",
    "orderAmount": "500",
    "payProduct": "15",
    "description": "111111",
    "merId": "8202000000430043",
    "currency": "MXN",
    "merOrderNo": "123123",
    "account": "659423129000010284",
    "bankId": "90659",
    "customerName": "sss",
    "customerIdentification": "12312312",
    "nonceStr": "12312",
    "sign": "376DA2980FD37223FD2CFB7BA3E0B9C8"
}

# 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

order amount orderAmount yes String

payment Products payProduct yes String

merchant number merId yes String

currency currency yes String

customer mailbox customerEmail yes String

customer phone number customerPhone yes String

downstream merchant order number merOrderNo yes String

account account yes String

account type accountType yes String

bank number bankId required when the payment method is bank card String

bank name bankName no String

customer name customerName yes String

customer address customerAddress no String

customer Identification Number customerIdentification yes String ID number or identity certificate
customer Identification number type customerIdentificationType required when the payment method is bank card String

order description description 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"
callback address callbackUrl no String for more information, see notification callback-API"

# 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

order amount orderAmount yes String

payment Products payProduct yes String

merchant number merId yes String

currency currency yes String

customer mailbox customerEmail no String

customer phone number customerPhone no String

downstream merchant order number merOrderNo yes String

account account yes String

account type accountType yes String

bank number bankId required when the bankName parameter is another bank String

bank name bankName yes String

customer name customerName yes String

customer address customerAddress no String

customer Identification Number customerIdentification yes String ID number or identity certificate
customer Identification number type customerIdentificationType yes String

order description description 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"
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

← Transaction Inquiries →