Conekta API
Conekta sdk
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Conekta sdk
Endpoints 120
Apple Pay
- POSTCreate Apple Pay Session
/apple_pay/sessionValidate an Apple Pay merchant session using Conekta's Apple Pay certificates. Call this endpoint from your backend with the validationURL received in the…
Subscriptions
- GETList Subscriptions
/customers/:customer_id/subscriptionsGet a list of subscriptions for a customer - POSTCreate Subscription
/customers/:customer_id/subscriptionsCreate a new subscription for a customer (keeps existing subscriptions active) - GETGet Subscription
/customers/:customer_id/subscriptions/:idRetrieve a specific subscription - PUTUpdate Subscription
/customers/:customer_id/subscriptions/:idUpdate a specific subscription - GETGet Subscription Events
/customers/:customer_id/subscriptions/:id/eventsGet events for a specific subscription - POSTCancel Subscription
/customers/:customer_id/subscriptions/:id/cancelCancel a specific subscription - POSTPause Subscription
/customers/:customer_id/subscriptions/:id/pausePause a specific subscription - POSTResume Subscription
/customers/:customer_id/subscriptions/:id/resumeResume a specific paused subscription - POSTRetry Failed Payment
/customers/:customer_id/subscriptions/:id/retryRetry a failed payment for a specific subscription - GETGet Subscription [Deprecated]
/customers/:id/subscriptionDeprecated. DEPRECATED: This endpoint will be removed in version 2.3.0. - PUTUpdate Subscription [Deprecated]
/customers/:id/subscriptionDeprecated. DEPRECATED: This endpoint will be removed in version 2.3.0. You can modify the subscription to change the plans that your customers consume - POSTCreate Subscription [Deprecated]
/customers/:id/subscriptionDeprecated. DEPRECATED: This endpoint will be removed in version 2.3.0. You can create the subscription to include the plans that your customers consume - POSTCancel Subscription [Deprecated]
/customers/:id/subscription/cancelDeprecated. DEPRECATED: This endpoint will be removed in version 2.3.0. - GETGet Subscription Events [Deprecated]
/customers/:id/subscription/eventsDeprecated. DEPRECATED: This endpoint will be removed in version 2.3.0. You can get the events of the subscription(s) of a client, with the customer id - POSTPause Subscription [Deprecated]
/customers/:id/subscription/pauseDeprecated. DEPRECATED: This endpoint will be removed in version 2.3.0. - POSTResume Subscription [Deprecated]
/customers/:id/subscription/resumeDeprecated. DEPRECATED: This endpoint will be removed in version 2.3.0.
Subscriptions - Customer Portal
- GETGet customer portal
/subscriptions/:subscription_id/customer_portalRetrieves the customer portal for a subscription - POSTCreate customer portal
/subscriptions/:subscription_id/customer_portalCreates a customer portal for a subscription. If a portal already exists, returns the existing one.
Antifraud
- GETGet a list of whitelisted rules
/antifraud/whitelistsReturn all rules - POSTCreate whitelisted rule
/antifraud/whitelists - DELETEDelete whitelisted rule
/antifraud/whitelists/:id - GETGet list of blacklisted rules
/antifraud/blacklistsReturn all rules - POSTCreate blacklisted rule
/antifraud/blacklists - DELETEDelete blacklisted rule
/antifraud/blacklists/:id
Api Keys
- GETGet list of Api Keys
/api_keysConsume the list of api keys you have - POSTCreate Api Key
/api_keysCreate a api key - GETGet Api Key
/api_keys/:idGets a api key that corresponds to a api key ID - PUTUpdate Api Key
/api_keys/:idUpdate an existing api key - DELETEDelete Api Key
/api_keys/:idDeletes a api key that corresponds to a api key ID
Balances
- GETGet a company's balance
/balanceGet a company's balance
Charges
- GETGet A List of Charges
/charges - PUTUpdate a charge
/charges/:id - POSTCreate charge
/orders/:id/chargesCreate charge for an existing orden - POSTCreate charges
/orders/:id/add_chargesCreate charges for an existing orden
Chargebacks
- GETGet Chargeback Files
/charges/:charge_id/chargebacks/:chargeback_id/filesRetrieve the list of evidence files uploaded for a chargeback. - GETGet Chargeback File
/charges/:charge_id/chargebacks/:chargeback_id/files/:file_idRetrieve the metadata and a presigned download URL for a single chargeback evidence file. - POSTUpload Chargeback Evidence Files (Batch)
/charges/:charge_id/chargebacks/:chargeback_id/files/batchUploads multiple evidence files for a chargeback in a single request. Each part of the multipart body must be keyed by an evidence type (see the… - GETGet Chargeback Evidence Types
/charges/:charge_id/chargebacks/:chargeback_id/evidence-typesRetrieve the catalog of evidence types accepted for a chargeback, including which are mandatory and their allowed file formats.
Companies
- GETGet List of Companies
/companiesConsume the list of child companies. This is used for holding companies with several child entities. - POSTCreate Company
/companiesCreate a new company. - GETGet Company
/companies/:id - GETGet Current Company
/companies/currentRetrieves information about the currently authenticated company. This endpoint returns the same data as the standard company endpoint but automatically uses… - POSTUpload Company Document
/companies/:company_id/documentUploads a document associated with a specific company. - PATCHUpdate Company Document
/companies/:company_id/documentUpdates an existing document associated with a specific company. - GETGet Company Documents
/companies/:company_id/documentsRetrieve a list of documents associated with a specific company. - GETGet Payment Method Settings
/settings/payment-methodsRetrieves the enablement status of each payment method for the currently authenticated company. For every payment method the response indicates whether it is…
Customers
- GETGet a list of customers
/customersThe purpose of business is to create and maintain a client, you will learn what elements you need to obtain a list of clients, which can be paged. - POSTCreate customer
/customersThe purpose of business is to create and keep a customer, you will learn what elements you need to create a customer. Remember the credit and debit card… - GETGet Customer
/customers/:idGets a customer resource that corresponds to a customer ID. - PUTUpdate customer
/customers/:idYou can update customer-related data - DELETEDelete Customer
/customers/:idDeleted a customer resource that corresponds to a customer ID. - POSTCreate Fiscal Entity
/customers/:id/fiscal_entitiesCreate Fiscal entity resource that corresponds to a customer ID. - PUTUpdate Fiscal Entity
/customers/:id/fiscal_entities/:fiscal_entities_idUpdate Fiscal Entity resource that corresponds to a customer ID.
Discounts
- GETGet a List of Discount
/orders/:id/discount_linesGet discount lines for an existing orden - POSTCreate Discount
/orders/:id/discount_linesCreate discount lines for an existing orden - GETGet Discount
/orders/:id/discount_lines/:discount_lines_idGet an existing discount lines for an existing orden - PUTUpdate Discount
/orders/:id/discount_lines/:discount_lines_idUpdate an existing discount lines for an existing orden - DELETEDelete Discount
/orders/:id/discount_lines/:discount_lines_idDelete an existing discount lines for an existing orden
Events
- GETGet list of Events
/events - GETGet Event
/events/:idReturns a single event - POSTResend Event
/events/:event_id/resendResend event to selected webhooks
Logs
- GETGet List Of Logs
/logsGet log details in the form of a list - GETGet Log
/logs/:idGet the details of a specific log
Monthly Installments
- POSTValidate Monthly Installments
/monthly_installments/validateReturns the interest-free monthly installment plans available for a card BIN and an amount, so a checkout can offer only the plans a later charge will accept.…
Orders
- GETGet a list of Orders
/ordersGet order details in the form of a list - POSTCreate order
/ordersCreate a new order. - GETGet Order
/orders/:idInfo for a specific order - PUTUpdate Order
/orders/:idUpdate an existing Order. - POSTCancel Order
/orders/:id/cancelCancel an order that has been previously created. - POSTCapture Order
/orders/:id/captureProcesses an order that has been previously authorized. - POSTVoid Order
/orders/:id/voidVoid an order that has been previously authorized and not yet captured. The order and its charges are moved to the voided status. - POSTRefund Order
/orders/:id/refundsA refunded order describes the items, amount, and reason an order is being refunded. - DELETECancel Refund
/orders/:id/refunds/:refund_idA refunded order describes the items, amount, and reason an order is being refunded.
Products
- POSTCreate Product
/orders/:id/line_itemsCreate a new product for an existing order. - PUTUpdate Product
/orders/:id/line_items/:line_item_idUpdate an existing product for an existing orden - DELETEDelete Product
/orders/:id/line_items/:line_item_idDelete product for an existing orden
Payout Orders
- GETGet a list of Payout Orders
/payout_ordersGet Payout order details in the form of a list - POSTCreate payout order
/payout_ordersCreate a new payout order. - GETGet Payout Order
/payout_orders/:idGets a payout Order resource that corresponds to a payout order ID. - PUTCancel Payout Order
/payout_orders/:id/cancelCancel a payout Order resource that corresponds to a payout order ID.
Payment Link
- GETGet a list of payment links
/checkoutsReturns a list of links generated by the merchant - POSTCreate Unique Payment Link
/checkouts - GETGet a payment link by ID
/checkouts/:id - PUTCancel Payment Link
/checkouts/:id/cancel - POSTSend an email
/checkouts/:id/email
Payment Methods
- GETGet Payment Methods
/customers/:id/payment_sourcesGet a list of Payment Methods - POSTCreate Payment Method
/customers/:id/payment_sourcesCreate a payment method for a customer. - PUTUpdate Payment Method
/customers/:id/payment_sources/:payment_method_idGets a payment Method that corresponds to a customer ID. - DELETEDelete Payment Method
/customers/:id/payment_sources/:payment_method_idDelete an existing payment method
Plans
- GETGet A List of Plans
/plans - POSTCreate Plan
/plansCreate a new plan for an existing order - GETGet Plan
/plans/:id - PUTUpdate Plan
/plans/:id - DELETEDelete Plan
/plans/:id
Shippings
- POSTCreate Shipping
/orders/:id/shipping_linesCreate new shipping for an existing orden - PUTUpdate Shipping
/orders/:id/shipping_lines/:shipping_idUpdate existing shipping for an existing orden - DELETEDelete Shipping
/orders/:id/shipping_lines/:shipping_idDelete shipping
Shipping Contacts
- POSTCreate a shipping contacts
/customers/:id/shipping_contactsCreate a shipping contacts for a customer. - PUTUpdate shipping contacts
/customers/:id/shipping_contacts/:shipping_contacts_idUpdate shipping contact that corresponds to a customer ID. - DELETEDelete shipping contacts
/customers/:id/shipping_contacts/:shipping_contacts_idDelete shipping contact that corresponds to a customer ID.
Taxes
- POSTCreate Tax
/orders/:id/tax_linesCreate new taxes for an existing orden - PUTUpdate Tax
/orders/:id/tax_lines/:tax_idUpdate taxes for an existing orden - DELETEDelete Tax
/orders/:id/tax_lines/:tax_idDelete taxes for an existing orden
Tokens
- POSTCreate Token
/tokensGenerate a payment token, to associate it with a card, Endpoint could be use directly only for PCI compliance account
Transactions
- GETGet List transactions
/transactionsGet transaction details in the form of a list - GETGet transaction
/transactions/:idGet the details of a transaction
Transfers
- GETGet a list of transfers
/transfersGet transfers details in the form of a list - GETGet Transfer
/transfers/:idGet the details of a Transfer
Webhook keys
- GETGet List of Webhook Keys
/webhook_keysConsume the list of webhook keys you have - POSTCreate Webhook Key
/webhook_keysCreate a webhook key - GETGet Webhook Key
/webhook_keys/:id - PUTUpdate Webhook Key
/webhook_keys/:idupdates an existing webhook key - DELETEDelete Webhook key
/webhook_keys/:id
Webhooks
- GETGet List of Webhooks
/webhooksConsume the list of webhooks you have, each environment supports 10 webhooks (For production and testing) - POSTCreate Webhook
/webhooksWhat we do at Conekta translates into events. For example, an event of interest to us occurs at the time a payment is successfully processed. At that moment… - GETGet Webhook
/webhooks/:id - PUTUpdate Webhook
/webhooks/:idupdates an existing webhook - DELETEDelete Webhook
/webhooks/:id - POSTTest Webhook
/webhooks/:id/testSend a webhook.ping event
API details
- Base URL
https://api.conekta.io- Authentication
- A bearer token in the Authorization header
- Operations
- 120 operations on 83 pathsGET 45POST 42PUT 18DELETE 14PATCH 1
7 marked deprecated - Main resources
- Subscriptions 16Orders 9Companies 8Customers 7Antifraud 6Webhooks 6Api Keys 5Discounts 5Payment Link 5Plans 5
- Response formats
application/vnd.conekta-v2.3.0+jsonapplication/json- Description format
- OpenAPI 3.1.0, API version
2.3.0 - Links
- OpenAPI document · Support
- Listed from
- Conekta's published OpenAPI description (conekta/openapi) (MIT)
How to test the Conekta API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Conekta API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create Apple Pay Session” (POST /apple_pay/session), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Conekta API?
Conekta sdk It is listed under Payments and has 120 endpoints.
Who publishes the Conekta API?
It is listed from Conekta's public API description (an OpenAPI document), not published by Conekta on Swastik Codes. Anyone who controls conekta.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Conekta API?
Requests go to https://api.conekta.io. Endpoint paths are added to this base URL.
How do I authenticate with the Conekta API?
With A bearer token in the Authorization header.
How many endpoints does the Conekta API have?
120 operations on 83 paths (45 GET, 42 POST, 18 PUT, 14 DELETE, 1 PATCH). The largest groups are Subscriptions, Orders, Companies, Customers.
Is forking the Conekta API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.