Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ChargeDesk Gateway API

Live payment processing operations

ChargeDesk Gateway API is one of 7 APIs that ChargeDesk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Gateway. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.chargedesk.com/v1.

6 operations 6 paths 7 schemas 6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.chargedesk.com/v1
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

ChargeDesk Gateway API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Use your ChargeDesk secret key as the username with an empty password. Format: Authorization: YOURSECRETKEY:

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.

Gateway 6

Live payment processing operations

POST
/gateway/products/charge
Create a live charge, subscription, or payment request via gateway
gatewayCreateCharge body → 200400401
POST
/gateway/charges/{charge_id}/refund
Refund a charge via gateway
gatewayRefundCharge 1 param body → 200401404
POST
/gateway/charges/{charge_id}/capture
Capture an authorized charge via gateway
gatewayCapturCharge 1 param body → 200401404
POST
/gateway/charges/{charge_id}/void
Cancel a payment request (void)
gatewayCancelPaymentRequest 1 param → 200401404
POST
/gateway/subscriptions/{subscription_id}/cancel
Cancel a subscription via gateway
gatewayCancelSubscription 1 param body → 200401404
POST
/gateway/subscriptions/{subscription_id}/plans
Edit subscription plans via gateway
gatewayEditSubscriptionPlans 1 param body → 200401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Charge (16 properties), Subscription (16 properties), ChargeLineItem (5 properties), CustomerRef (3 properties). Each schema is shown below with its type and property counts.

ProductRef
object
2 properties
Subscription
object
16 properties
SubscriptionRef
object
1 property
ChargeLineItem
object
5 properties
CustomerRef
object
3 properties
Charge
object
16 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chargedesk-gateway-api-openapi.yml Raw ↑

Other APIs ChargeDesk publishes across the network.

ChargeDesk REST API
ChargeDesk Charges API
ChargeDesk Customers API
ChargeDesk Products API
ChargeDesk Subscriptions API
ChargeDesk Webhooks API