Merchant API

This API provides information about the merchant and allows for transaction searches. With these endpoints, you can retrieve merchant profile data and search for specific transactions using their unique identifiers.

Endpoints

Retrieve Merchant Information

/api/v1/merchant/me

Provides a concise summary of the registered merchant’s corporate and financial profile. The response includes key data such as tax ID, electronic contact information, operating currency, and current e-wallet balance.

Request Headers

string

required

Token for authentication

Response

string

required

Response code (e.g., “01”)

string

required

Status of the response (e.g., “SUCCESS”)

string

Additional message about the response

object

required

Show Merchant data object

string

Merchant’s registered name (e.g., “Acme Corporation”)

string

Merchant’s tax ID (e.g., “2523423”)

string

Merchant’s registered email (e.g., “example@tumipay.co”)

string

Operating currency (e.g., “COP”)

integer

Current e-wallet balance (e.g., 954943500)

curl --request GET 'https://api-empresas.staging.topup.com.co/production/api/v1/merchant/me' \
--header 'Token-Top: your_auth_token'

{
  "code": "01",
  "status": "SUCCESS",
  "message": "",
  "data": {
    "name": "Acme Corporation",
    "nit": "2523423",
    "email": "example@tumipay.co",
    "currency": "COP",
    "wallet": 954943500
  }
}

Search Transactions

/api/v1/transaction/{ticket}

Search for transaction details using either the ticket provided by TumiPay or the reference supplied by the merchant. The “ticket” parameter accepts both the TumiPay ticket and the merchant’s reference for payin or payout transactions.

Request Headers

string

required

Token for authentication

Request Body

string

required

Ticket or reference of the transaction (e.g., “1740ed7e-bbab-11ee-8335-02530a7dec0f”)

Response

string

required

Response code (e.g., “01”)

string

required

Status of the transaction (e.g., “SUCCESS”)

object

required

Show Transaction data object

string

TumiPay ticket for the transaction (e.g., “41ac80c3-2f50-11ef-a534-02530a7dec0f”)

string

Reference provided by the merchant (e.g., “uel7aWiavpwR8uXBkqMH3AiC165855”)

integer

Transaction amount (e.g., 5000000)

string

Transaction currency (e.g., “COP”, “PEN”)

string

Type of transaction (e.g., “Deposit”)

object

Show Customer details object

string

Type of customer’s legal document (e.g., “CC”)

string

Customer’s legal document number (e.g., “9012286480”)

string

Country code for the customer’s phone number (e.g., “57”)

string

Customer’s phone number (e.g., “3216132616”)

string

Customer’s email address (e.g., “approved@tumipay.co”)

string

Full name of the customer (e.g., “3013540830”)

string

Current status of the transaction (e.g., “APPROVED”)

string

Message associated with the transaction’s status (e.g., “Transaction approved”)

string

Timestamp of the transaction (e.g., “2024-06-20 16:58:55”)

curl --request POST 'https://api-empresas.staging.topup.com.co/production/api/v1/transaction/{ticket}' \
--header 'Token-Top: your_auth_token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ticket": "1740ed7e-bbab-11ee-8335-02530a7dec0f"
}'

// Using fetch API
const response = await fetch('https://api-empresas.staging.topup.com.co/production/api/v1/transaction/{ticket}', {
  method: 'POST',
  headers: {
    'Token-Top': 'your_auth_token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    ticket: '1740ed7e-bbab-11ee-8335-02530a7dec0f'
  })
});
const data = await response.json();

{
  "code": "01",
  "status": "SUCCESS",
  "data": {
    "ticket": "41ac80c3-2f50-11ef-a534-02530a7dec0f",
    "reference": "uel7aWiavpwR8uXBkqMH3AiC165855",
    "amount": 5000000,
    "currency": "COP",
    "type_transaction": "Deposit",
    "customer": {
      "legal_doc_type": "CC",
      "legal_doc": "9012286480",
      "phone_code": "57",
      "phone_number": "3216132616",
      "email": "approved@tumipay.co",
      "full_name": "3013540830"
    },
    "status": "APPROVED",
    "response_message": "Transaction approved",
    "date": "2024-06-20 16:58:55"
  }
}

Getting Started

Merchant API

PayIn API

PayOut API

Card Payment API

Integration

Merchant API

Merchant API

Endpoints

Retrieve Merchant Information

/api/v1/merchant/me

Request Headers

Response

Search Transactions

/api/v1/transaction/{ticket}

Request Headers

Request Body

Response

​Merchant API

​Endpoints

​Retrieve Merchant Information

/api/v1/merchant/me

​Request Headers

​Response

​Search Transactions

/api/v1/transaction/{ticket}

​Request Headers

​Request Body

​Response

Merchant API

Endpoints

Retrieve Merchant Information

Request Headers

Response

Search Transactions

Request Headers

Request Body

Response