Cash

（payProduct=03）

Payment Process

1. The user places an order on the merchant's website and selects Cash payment;

2. The merchant initiates a Cash payment request to Supefina;

3. Supefina returns the Cash payment URL information;

4. The merchant displays the payment URL to the user;

5. The user pays according to the prompts on the page;

6. The payment is successful;

7. Supefina notifies the merchant that the order is successful.

The address of the request

The name of the environment	URL
SandBox	POST https://api.supefina.tech/api/supefina/transactions/payin
Formal environment	POST https://api.supefina.net/api/supefina/transactions/payin

Request parameters

Request header

Key	Value
Content-Type	application/json

Request body

Variable name	type	Required	description
countryId	String	Yes	Country number Reference:Dictionary table - country number Columbia，COL
currency	String	Yes	Currency Reference: Dictionary Table - Currency Colombian Peso：COP
orderAmount	String	Yes	The amount of the order 3000 >= orderAmount <= 2000000 Decimals are not supported
payProduct	String	Yes	Payment type Cash：03
merId	String	Yes	Merchant ID Merchant ID acquisition path: Supefina Merchant Background - Merchant Management - Basic Information - Merchant ID
merOrderNo	String	Yes	Merchant order number
sign	String	Yes	signature For details, please refer to: Signature algorithm
nonceStr	String	Yes	Random strings The length cannot exceed 32 bits
customerEmail	String	Yes	The user's email address The mailbox username cannot be just a number (for example, [email protected]) and You cannot make more than 20 payment requests per day in the same email address.
customerName	String	Yes	Username
customerPhone	String	Yes	User phone Ten digits starting with 3 are required
customerIdentification	String	Yes	The ID number of the user
checkOut	Boolean	Yes	Cash register true：The cashier is required false：The cash register is not required It is recommended to pass true
customerAccount	String	No	User Accounts checkOut must be passed when it is false
lastName	String	No	The user's last name checkOut must be passed when it is false
customerIdentificationType	String	No	The type of user ID 00：Identification Card（CC） 01：Alien Identity Card（CE） 02：Tax identification number 03：Passport 06：Miscellaneous 07：Proof of citizenship 08：Residence permit checkOut must be passed when it is false
customerAddress	String	No	User's address checkOut must be passed when it is false
tipo_persona	String	No	Payment Subject checkOut must be passed when it is false
bankId	String	No	Bank code
expireTimeL	Long	No	Expiration time Unit: seconds; Default: 10 minutes, maximum: 10 minutes
callbackUrl	String	No	Callback address For details, see Notification Callbacks
description	String	Yes	description It cannot contain special symbols and should not exceed 200 characters in length

Sample request

{
    "callbackUrl": "https://d3vf2zxd9jv8rh.cloudfront.net/apigate/v6sx2i/api/pay_notice/in_payback/payId/CDEA3CA37DBC4C2CB6301AED14011122",
    "checkOut": true,
    "countryId": "COL",
    "currency": "COP",
    "customerAccount": "60872832",
    "customerEmail": "[email protected]",
    "customerIdentification": "9145652857",
    "customerName": "Aaliyah Rogers",
    "customerPhone": "3073030686",
    "lastName": "cith",
    "merId": "8301113635310326",
    "merOrderNo": "R20240619032018545",
    "nonceStr": "6D9B18BFD37240EB846FC923059D001B",
    "orderAmount": "20000",
    "payProduct": "03",
    "sign": "727D7B7416A570284E97F295DECF8490",
    "description":"Supefina"
}

Response parameters

Variable name	type	description
code	String	Response coding For details, see Response Status Code
msg	String	Response Information
data	Object	Response data
merCode	String	Merchant ID
merOrderNo	String	Merchant order number
supefinaOrderId	String	Supefina order number
amount	BigDecimal	The amount of the order
fee	String	Advance handling fee will be charged
identifier	String	Payment reference identifier
transactionStatus	String	Order status Whether the initiation status of the order is successful or not has nothing to do with the real transaction status of the order. 00：The order is successful 04：Failed to place an order
url	String	Transaction links

Sample response

{
    "code": "string",
    "msg": "string",
    "data": {
        "merCode": "string",
        "merOrderNo": "string",
        "supefinaOrderNo": "string",
        "amount": 0,
        "fee": 0,
        "transactionStatus": "string",
        "url": "string",
        "identifier": "string"
    }
}

Callback notifications

Submission method：POST

Variable name	type	description
amount	String	The amount of the order
countryId	String	Country number Reference: Dictionary table - country number Columbia，COL
customerName	String	Username
fee	String	Advance handling fee will be charged
identifier	String	Payment Reference Clabe
merId	String	Merchant ID
merOrderId	String	Merchant order number
msg	String	message
nonceStr	String	Random strings The length cannot exceed 32 bits
realityAmount	String	Paid-in amount
realityFee	String	Actual handling fee
sign	String	signature
status	String	Transaction status For details, please refer to: Dictionary Table - Trading Order Status
successTime	Date	The time at which the transaction was successful UTC time
supefinaOrderId	String	Supefina order number
transactionType	String	The type of transaction 01：Payin 02：Payout

An example of a callback notification

{
    "amount": "20000.00",
    "countryId": "COL",
    "customerName": "Grace Shaw",
    "fee": "1000.00",
    "identifier": "706180968985601627",
    "merId": "8301409897370054",
    "merOrderId": "R20240619052050314",
    "msg": "",
    "nonceStr": "8b0c8dcd-14b6-4fef-a970-c914dc",
    "realityAmount": "20000",
    "realityFee": "1000.00",
    "sign": "FD1DD91503C4EC282E8CA01591973921",
    "status": "01",
    "successTime": 1718775146000,
    "supefinaOrderId": "2024061900010012b16f19beca043",
    "transactionType": "01"
}

Callback notification response

After the merchant successfully receives the callback, it needs to return the specified string synchronously: SUCCESS does not return or returns other content by default, and the notification fails As：

public String test(){
	return "SUCCESS";
}