Nequi

Call the Payments API to request payments via Nequi on Colombia

Here you'll find the specific parameters required for integrating this payment method in the selected country. These parameters are tailored to meet the unique requirements of this region and payment type. For a complete list of global parameters and detailed explanations, please refer to the Overview page, where you'll find all the foundational elements that apply across different countries and methods.

POST /v2/payin

Request

curl -v --location --request POST 'https://sandbox.smartfastpay.com/v2/payin' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer <Access-Token>' \
    --data-raw '{
        "customer": {
            "id": "58f0c005-3b7d-4c75-81f3-93b9a6fee864",
            "name": "Richard Roe",
            "email": "[e-mail]",
            "phone": "[phone]",
            "document": {
                "number": "12345678",
                "type": "CC"
            }
        },
        "transaction": {
            "id": "b08e3897-6505-4bb4-81a5-6e3a1d29e277",
            "currency": "COP",
            "amount": 2000,
        },
        "country": "COL",
        "payment_method": "nequi",
        "notification_url": "https://mysite.com/api/notification"
    }'

Parameters details

Parameter	Type	Required	Description
customer.id	string	yes	Unique identifier for the customer in your system. This value should remain consistent across all transactions for the same customer
customer.name	string	yes	The full name of the customer making the payment. It should match the name on the customer's identification documents
customer.email	string	yes	The email address of the customer. This will be used for sending payment confirmations and notifications
customer.phone	string	yes	The phone number of the customer, including the country code. This parameter may be optional or required depending on the payment method used
customer.document.number	string	yes	The official identification number of the customer. This is typically a national ID, passport, or other government-issued document
customer.document.type	string	yes	The type of document provided by the customer. Common types include national ID, passport, or driver's license. List of documents allowed.
transaction.id	string	yes	A unique identifier for the transaction. This ID should be generated by your system to track the specific payment process
transaction.currency	string	yes	The currency in which the transaction is being conducted. Use standard ISO 4217 currency codes (e.g., USD, PEN). List of currency codes.
transaction.amount	decimal (10,2)	yes	The total amount of the transaction in the specified currency. This value should be a numeric amount (use dot instead of comma) Eg: 300.10
transaction.expire	integer (11)	no	The time in seconds until the transaction expires and is no longer valid
branch	string	no	The specific branch or location identifier where the transaction is being processed, if applicable
country	string	yes	The country code where the transaction is taking place. The format is ISO 3166-1 alpha-3 (e.g., BRA for Brazil). List of country codes.
payment_method	string	yes	The method of payment being used for the transaction, such as bank transfer, credit card...
notification_url	string	yes	The URL to which payment notifications will be sent. Ensure this URL is accessible and configured to handle the notification format

Response

success

{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "data": {
        "id": "4a79f3b4-8d55-428b-a560-984fedd6f78a",
        "status": "pending",
        "expires_in": 1722108649,
        "payment": {
            "method": "nequi",
            "url": "https://secure.payzen.lat/t/smartfastpay"
        },
        "values": {
            "source_total": "10000.00000000",
            "source_currency": "COP",
            "exchanged_total": "10000.00000000",
            "exchanged_currency": "COP",
            "exchange": 1.00,
            "fee": "200.00000000"
        }
    }
}

error

{
    "requestId": "b299549a8e75ead38c176932c3f59da0/13462186452875824120",
    "moreInformation": [
        {
            "code": "INVALID_REQUEST",
            "detail": "The transaction.id field is required."
        }
    ]
}

Response details following the link: overview