{ "opencollection": "1.0.0", "info": { "name": "Conekta API", "version": "2.2.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Antifraud", "type": "folder" }, "items": [ { "info": { "name": "Get a list of whitelisted rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/antifraud/whitelists", "headers": [ { "name": "Accept-Language", "value": "" } ] }, "docs": "Return all rules" }, { "info": { "name": "Create whitelisted rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/antifraud/whitelists", "headers": [ { "name": "Accept-Language", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create whitelisted rule" }, { "info": { "name": "Delete whitelisted rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/antifraud/whitelists/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ] }, "docs": "Delete whitelisted rule" }, { "info": { "name": "Get list of blacklisted rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/antifraud/blacklists", "headers": [ { "name": "Accept-Language", "value": "" } ] }, "docs": "Return all rules" }, { "info": { "name": "Create blacklisted rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/antifraud/blacklists", "headers": [ { "name": "Accept-Language", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create blacklisted rule" }, { "info": { "name": "Delete blacklisted rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/antifraud/blacklists/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ] }, "docs": "Delete blacklisted rule" } ] }, { "info": { "name": "Api Keys", "type": "folder" }, "items": [ { "info": { "name": "Get list of Api Keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/api_keys", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" }, { "name": "search", "value": "", "type": "query", "description": "General search, e.g. by id, description, prefix" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Consume the list of api keys you have" }, { "info": { "name": "Create Api Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/api_keys", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a api key" }, { "info": { "name": "Get Api Key", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/api_keys/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Gets a api key that corresponds to a api key ID" }, { "info": { "name": "Update Api Key", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/api_keys/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing api key" }, { "info": { "name": "Delete Api Key", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/api_keys/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes a api key that corresponds to a api key ID" } ] }, { "info": { "name": "Balances", "type": "folder" }, "items": [ { "info": { "name": "Get a company's balance", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/balance", "headers": [ { "name": "Accept-Language", "value": "" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a company's balance" } ] }, { "info": { "name": "Charges", "type": "folder" }, "items": [ { "info": { "name": "Get A List of Charges", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/charges", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get A List of Charges" }, { "info": { "name": "Update a charge", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/charges/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a charge" }, { "info": { "name": "Create charge", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/orders/:id/charges", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create charge for an existing orden" }, { "info": { "name": "Create charges", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/orders/:id/add_charges", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create charges for an existing orden" } ] }, { "info": { "name": "Companies", "type": "folder" }, "items": [ { "info": { "name": "Get List of Companies", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/companies", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Consume the list of child companies. This is used for holding companies with several child entities." }, { "info": { "name": "Create Company", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/companies", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new company." }, { "info": { "name": "Get Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/companies/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Company" }, { "info": { "name": "Get Current Company", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/companies/current", "headers": [ { "name": "Accept-Language", "value": "" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves information about the currently authenticated company. This endpoint returns the same data as the standard company endpoint but automatically uses the current company's context." }, { "info": { "name": "Upload Company Document", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/companies/:company_id/document", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company_id", "value": "", "type": "path", "description": "The unique identifier of the company." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Uploads a document associated with a specific company." }, { "info": { "name": "Update Company Document", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.conekta.io/companies/:company_id/document", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company_id", "value": "", "type": "path", "description": "The unique identifier of the company." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates an existing document associated with a specific company." }, { "info": { "name": "Get Company Documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/companies/:company_id/documents", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "company_id", "value": "", "type": "path", "description": "The unique identifier of the company." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a list of documents associated with a specific company." } ] }, { "info": { "name": "Customers", "type": "folder" }, "items": [ { "info": { "name": "Get a list of customers", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The 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." }, { "info": { "name": "Create customer", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The purpose of business is to create and keep a customer, you will learn what elements you need to create a customer.\nRemember the credit and debit card tokenization process: [https://developers.conekta.com/page/web-checkout-tokenizer](https://developers.conekta.com/page/web-checkout-tokenizer)\n" }, { "info": { "name": "Get Customer", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Gets a customer resource that corresponds to a customer ID." }, { "info": { "name": "Update customer", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/customers/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "You can update customer-related data" }, { "info": { "name": "Delete Customer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/customers/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deleted a customer resource that corresponds to a customer ID." }, { "info": { "name": "Create Fiscal Entity", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:id/fiscal_entities", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Fiscal entity resource that corresponds to a customer ID." }, { "info": { "name": "Update Fiscal Entity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/customers/:id/fiscal_entities/:fiscal_entities_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "fiscal_entities_id", "value": "fis_ent_2tQ8HkkfbauaKP9Ho", "type": "path", "description": "identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Fiscal Entity resource that corresponds to a customer ID." } ] }, { "info": { "name": "Discounts", "type": "folder" }, "items": [ { "info": { "name": "Get a List of Discount", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/orders/:id/discount_lines", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get discount lines for an existing orden" }, { "info": { "name": "Create Discount", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/orders/:id/discount_lines", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create discount lines for an existing orden" }, { "info": { "name": "Get Discount", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/orders/:id/discount_lines/:discount_lines_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "discount_lines_id", "value": "dis_lin_2tQ974hSHcsdeSZHG", "type": "path", "description": "discount line id identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get an existing discount lines for an existing orden" }, { "info": { "name": "Update Discount", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/orders/:id/discount_lines/:discount_lines_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "discount_lines_id", "value": "dis_lin_2tQ974hSHcsdeSZHG", "type": "path", "description": "discount line id identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing discount lines for an existing orden" }, { "info": { "name": "Delete Discount", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/orders/:id/discount_lines/:discount_lines_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "discount_lines_id", "value": "dis_lin_2tQ974hSHcsdeSZHG", "type": "path", "description": "discount line id identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an existing discount lines for an existing orden" } ] }, { "info": { "name": "Events", "type": "folder" }, "items": [ { "info": { "name": "Get list of Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/events", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get list of Events" }, { "info": { "name": "Get Event", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/events/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a single event" }, { "info": { "name": "Resend Event", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/events/:event_id/resend", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "event_id", "value": "6463d6e35a4c3e001819e760", "type": "path", "description": "event identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Resend event to selected webhooks" } ] }, { "info": { "name": "Logs", "type": "folder" }, "items": [ { "info": { "name": "Get List Of Logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/logs", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get log details in the form of a list" }, { "info": { "name": "Get Log", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/logs/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the details of a specific log" } ] }, { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Get a list of Orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/orders", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" }, { "name": "payment_status", "value": "", "type": "query", "description": "Filters by order status" }, { "name": "last_payment_info.status", "value": "", "type": "query", "description": "Filters by last payment info status" }, { "name": "created_at", "value": "", "type": "query", "description": "created equal to" }, { "name": "created_at.gte", "value": "", "type": "query", "description": "created at greater than or equal to" }, { "name": "created_at.lte", "value": "", "type": "query", "description": "created at less than or equal to" }, { "name": "updated_at.gte", "value": "", "type": "query", "description": "updated at greater than or equal to" }, { "name": "updated_at.lte", "value": "", "type": "query", "description": "updated at less than or equal to" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get order details in the form of a list" }, { "info": { "name": "Create order", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/orders", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new order." }, { "info": { "name": "Get Order", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/orders/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Info for a specific order" }, { "info": { "name": "Update Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/orders/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing Order." }, { "info": { "name": "Cancel Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/orders/:id/cancel", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel an order that has been previously created." }, { "info": { "name": "Capture Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/orders/:id/capture", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Processes an order that has been previously authorized." }, { "info": { "name": "Refund Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/orders/:id/refunds", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "A refunded order describes the items, amount, and reason an order is being refunded." }, { "info": { "name": "Cancel Refund", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/orders/:id/refunds/:refund_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "refund_id", "value": "6407b5bee1329a000175ba11", "type": "path", "description": "refund identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "A refunded order describes the items, amount, and reason an order is being refunded." } ] }, { "info": { "name": "Products", "type": "folder" }, "items": [ { "info": { "name": "Create Product", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/orders/:id/line_items", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new product for an existing order." }, { "info": { "name": "Update Product", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/orders/:id/line_items/:line_item_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "line_item_id", "value": "line_item_2tQ8HkkfbauaKP9Ho", "type": "path", "description": "identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing product for an existing orden" }, { "info": { "name": "Delete Product", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/orders/:id/line_items/:line_item_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "line_item_id", "value": "line_item_2tQ8HkkfbauaKP9Ho", "type": "path", "description": "identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete product for an existing orden" } ] }, { "info": { "name": "Payout Orders", "type": "folder" }, "items": [ { "info": { "name": "Get a list of Payout Orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/payout_orders", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Payout order details in the form of a list" }, { "info": { "name": "Create payout order", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/payout_orders", "headers": [ { "name": "Accept-Language", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new payout order." }, { "info": { "name": "Get Payout Order", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/payout_orders/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Gets a payout Order resource that corresponds to a payout order ID." }, { "info": { "name": "Cancel Payout Order", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/payout_orders/:id/cancel", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel a payout Order resource that corresponds to a payout order ID." } ] }, { "info": { "name": "Payment Link", "type": "folder" }, "items": [ { "info": { "name": "Get a list of payment links", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/checkouts", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a list of links generated by the merchant" }, { "info": { "name": "Create Unique Payment Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/checkouts", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create Unique Payment Link" }, { "info": { "name": "Get a payment link by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/checkouts/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a payment link by ID" }, { "info": { "name": "Cancel Payment Link", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/checkouts/:id/cancel", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel Payment Link" }, { "info": { "name": "Send an email", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/checkouts/:id/email", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Send an email" }, { "info": { "name": "Send an sms", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/checkouts/:id/sms", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Send an sms" } ] }, { "info": { "name": "Payment Methods", "type": "folder" }, "items": [ { "info": { "name": "Get Payment Methods", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:id/payment_sources", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a list of Payment Methods" }, { "info": { "name": "Create Payment Method", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:id/payment_sources", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a payment method for a customer." }, { "info": { "name": "Update Payment Method", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/customers/:id/payment_sources/:payment_method_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "payment_method_id", "value": "src_2tQ974hSHcsdeSZHG", "type": "path", "description": "Identifier of the payment method" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Gets a payment Method that corresponds to a customer ID." }, { "info": { "name": "Delete Payment Method", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/customers/:id/payment_sources/:payment_method_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "payment_method_id", "value": "src_2tQ974hSHcsdeSZHG", "type": "path", "description": "Identifier of the payment method" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an existing payment method" } ] }, { "info": { "name": "Plans", "type": "folder" }, "items": [ { "info": { "name": "Get A List of Plans", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/plans", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get A List of Plans" }, { "info": { "name": "Create Plan", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/plans", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new plan for an existing order" }, { "info": { "name": "Get Plan", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/plans/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Plan" }, { "info": { "name": "Update Plan", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/plans/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update Plan" }, { "info": { "name": "Delete Plan", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/plans/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Plan" } ] }, { "info": { "name": "Shippings", "type": "folder" }, "items": [ { "info": { "name": "Create Shipping", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/orders/:id/shipping_lines", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create new shipping for an existing orden" }, { "info": { "name": "Update Shipping", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/orders/:id/shipping_lines/:shipping_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "shipping_id", "value": "ship_lin_2tQ974hSHcsdeSZHG", "type": "path", "description": "identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update existing shipping for an existing orden" }, { "info": { "name": "Delete Shipping", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/orders/:id/shipping_lines/:shipping_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "shipping_id", "value": "ship_lin_2tQ974hSHcsdeSZHG", "type": "path", "description": "identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete shipping" } ] }, { "info": { "name": "Shipping Contacts", "type": "folder" }, "items": [ { "info": { "name": "Create a shipping contacts", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:id/shipping_contacts", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a shipping contacts for a customer." }, { "info": { "name": "Update shipping contacts", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/customers/:id/shipping_contacts/:shipping_contacts_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "shipping_contacts_id", "value": "6307a60c41de27127515a575", "type": "path", "description": "identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update shipping contact that corresponds to a customer ID." }, { "info": { "name": "Delete shipping contacts", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/customers/:id/shipping_contacts/:shipping_contacts_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "shipping_contacts_id", "value": "6307a60c41de27127515a575", "type": "path", "description": "identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete shipping contact that corresponds to a customer ID." } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "List Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:customer_id/subscriptions", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a list of subscriptions for a customer" }, { "info": { "name": "Create Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:customer_id/subscriptions", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new subscription for a customer (keeps existing subscriptions active)" }, { "info": { "name": "Get Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a specific subscription" }, { "info": { "name": "Update Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a specific subscription" }, { "info": { "name": "Get Subscription Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id/events", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" }, { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get events for a specific subscription" }, { "info": { "name": "Cancel Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id/cancel", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel a specific subscription" }, { "info": { "name": "Pause Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id/pause", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Pause a specific subscription" }, { "info": { "name": "Resume Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id/resume", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Resume a specific paused subscription" }, { "info": { "name": "Retry Failed Payment", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:customer_id/subscriptions/:id/retry", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "customer_id", "value": "", "type": "path", "description": "Identifier of the customer resource" }, { "name": "id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retry a failed payment for a specific subscription" }, { "info": { "name": "Get Subscription [Deprecated]", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:id/subscription", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0." }, { "info": { "name": "Create Subscription [Deprecated]", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:id/subscription", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0. You can create the subscription to include the plans that your customers consume" }, { "info": { "name": "Update Subscription [Deprecated]", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/customers/:id/subscription", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0. You can modify the subscription to change the plans that your customers consume" }, { "info": { "name": "Cancel Subscription [Deprecated]", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:id/subscription/cancel", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0." }, { "info": { "name": "Get Subscription Events [Deprecated]", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/customers/:id/subscription/events", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Pause Subscription [Deprecated]", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:id/subscription/pause", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0." }, { "info": { "name": "Resume Subscription [Deprecated]", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/customers/:id/subscription/resume", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DEPRECATED: This endpoint will be removed in version 2.3.0." } ] }, { "info": { "name": "Subscriptions - Customer Portal", "type": "folder" }, "items": [ { "info": { "name": "Get customer portal", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/subscriptions/:subscription_id/customer_portal", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves the customer portal for a subscription" }, { "info": { "name": "Create customer portal", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/subscriptions/:subscription_id/customer_portal", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "subscription_id", "value": "", "type": "path", "description": "Identifier of the subscription resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a customer portal for a subscription. If a portal already exists, returns the existing one." } ] }, { "info": { "name": "Taxes", "type": "folder" }, "items": [ { "info": { "name": "Create Tax", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/orders/:id/tax_lines", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create new taxes for an existing orden" }, { "info": { "name": "Update Tax", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/orders/:id/tax_lines/:tax_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "tax_id", "value": "tax_lin_2tQ974hSHcsdeSZHG", "type": "path", "description": "identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update taxes for an existing orden" }, { "info": { "name": "Delete Tax", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/orders/:id/tax_lines/:tax_id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" }, { "name": "tax_id", "value": "tax_lin_2tQ974hSHcsdeSZHG", "type": "path", "description": "identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete taxes for an existing orden" } ] }, { "info": { "name": "Tokens", "type": "folder" }, "items": [ { "info": { "name": "Create Token", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/tokens", "headers": [ { "name": "Accept-Language", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate a payment token, to associate it with a card, Endpoint could be use directly only for PCI compliance account\n" } ] }, { "info": { "name": "Transactions", "type": "folder" }, "items": [ { "info": { "name": "Get List transactions", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/transactions", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" }, { "name": "id", "value": "", "type": "query", "description": "id of the object to be retrieved" }, { "name": "charge_id", "value": "", "type": "query", "description": "id of the charge used for filtering" }, { "name": "type", "value": "", "type": "query", "description": "type of the object to be retrieved" }, { "name": "currency", "value": "", "type": "query", "description": "currency of the object to be retrieved" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get transaction details in the form of a list" }, { "info": { "name": "Get transaction", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/transactions/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the details of a transaction" } ] }, { "info": { "name": "Transfers", "type": "folder" }, "items": [ { "info": { "name": "Get a list of transfers", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/transfers", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get transfers details in the form of a list" }, { "info": { "name": "Get Transfer", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/transfers/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the details of a Transfer" } ] }, { "info": { "name": "Webhook keys", "type": "folder" }, "items": [ { "info": { "name": "Get List of Webhook Keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/webhook_keys", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Consume the list of webhook keys you have" }, { "info": { "name": "Create Webhook Key", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/webhook_keys", "headers": [ { "name": "Accept-Language", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a webhook key" }, { "info": { "name": "Get Webhook Key", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/webhook_keys/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Webhook Key" }, { "info": { "name": "Update Webhook Key", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/webhook_keys/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "updates an existing webhook key" }, { "info": { "name": "Delete Webhook key", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/webhook_keys/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Webhook key" } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "Get List of Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/webhooks", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The numbers of items to return, the maximum value is 250" }, { "name": "search", "value": "", "type": "query", "description": "General order search, e.g. by mail, reference etc." }, { "name": "url", "value": "", "type": "query", "description": "url for webhook filter" }, { "name": "next", "value": "", "type": "query", "description": "next page" }, { "name": "previous", "value": "", "type": "query", "description": "previous page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Consume the list of webhooks you have, each environment supports 10 webhooks (For production and testing)" }, { "info": { "name": "Create Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/webhooks", "headers": [ { "name": "Accept-Language", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "What 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 we will be interested in doing several things: Send an email to the buyer, generate an invoice, start the process of shipping the product, etc." }, { "info": { "name": "Get Webhook", "type": "http" }, "http": { "method": "GET", "url": "https://api.conekta.io/webhooks/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Webhook" }, { "info": { "name": "Update Webhook", "type": "http" }, "http": { "method": "PUT", "url": "https://api.conekta.io/webhooks/:id", "headers": [ { "name": "Accept-Language", "value": "" }, { "name": "X-Child-Company-Id", "value": "6441b6376b60c3a638da80af" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "updates an existing webhook" }, { "info": { "name": "Delete Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.conekta.io/webhooks/:id", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Webhook" }, { "info": { "name": "Test Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.conekta.io/webhooks/:id/test", "headers": [ { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "id", "value": "6307a60c41de27127515a575", "type": "path", "description": "Identifier of the resource" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Send a webhook.ping event" } ] } ], "bundled": true }