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
/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.
Response Response code (e.g., “01”)
Status of the response (e.g., “SUCCESS”)
Additional message about the response
Show Merchant data object
Merchant’s registered name (e.g., “Acme Corporation”)
Merchant’s tax ID (e.g., “2523423”)
Operating currency (e.g., “COP”)
Current e-wallet balance (e.g., 954943500)
curl --request GET 'https://api-empresas.staging.tumipay.co/production/api/v1/merchant/me' \ --header 'Token-Top: your_auth_token'
{ "code" : "01" , "status" : "SUCCESS" , "message" : "" , "data" : { "name" : "Acme Corporation" , "nit" : "2523423" , "email" : "[email protected] " , "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 Body Ticket or reference of the transaction (e.g., “1740ed7e-bbab-11ee-8335-02530a7dec0f”)
Response Response code (e.g., “01”)
Status of the transaction (e.g., “SUCCESS”)
Show Transaction data object
TumiPay ticket for the transaction (e.g., “41ac80c3-2f50-11ef-a534-02530a7dec0f”)
Reference provided by the merchant (e.g., “uel7aWiavpwR8uXBkqMH3AiC165855”)
Transaction amount (e.g., 5000000)
Transaction currency (e.g., “COP”, “PEN”)
Type of transaction (e.g., “Deposit”)
Show Customer details object
Type of customer’s legal document (e.g., “CC”)
Customer’s legal document number (e.g., “9012286480”)
Country code for the customer’s phone number (e.g., “57”)
Customer’s phone number (e.g., “3216132616”)
Full name of the customer (e.g., “3013540830”)
Current status of the transaction (e.g., “APPROVED”)
Message associated with the transaction’s status (e.g., “Transaction approved”)
Timestamp of the transaction (e.g., “2024-06-20 16:58:55”)
curl --request POST 'https://api-empresas.staging.tumipay.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" }'
{ "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" : "[email protected] " , "full_name" : "3013540830" }, "status" : "APPROVED" , "response_message" : "Transaction approved" , "date" : "2024-06-20 16:58:55" } }
