Skip to main content
API Referencev1.0 — Payments · Disbursements · Transactions · Chargebacks · Reporting

Accept Payments.
Settle and Disbursewith One Platform

REST APIs for card payments, saved cards, transaction lifecycle, chargebacks, deposit reporting, and disbursement workflows. Integrate server-side through the ChainIT Pay Public SDK at /public-api/v1/.

Explore API Docs →Getting Started
chainit-pay-api.js
const res = await fetch('/public-api/v1/payment-methods?isActive=true', {
  headers: {
    authorization: 'cip_<keyId>_<secret>',
    'x-organization-id': '<org-uuid>',
    'x-chainitpay-mid-id': '<mid-id>'
  }
});
ChainIT Pay REST API
Response: 200 OK
5
API Modules
32+
Public SDK Endpoints
3
Required Auth Headers
// API Reference

ChainIT Pay API Services

REST APIs for card payments, disbursements, transactions, chargebacks, and reporting — authenticated with your CIP API key, organization ID, and merchant MID.

💳

Payments

Card Capture & Saved Cards

List payment methods, look up transactions by order ID, and manage tokenized cards for returning customers. Cancel or refund sales through the Public SDK.

7 endpointsGETPATCHPOSTDELETE
🔀

Disbursements

Workflows API

List workflows, set up an execution, continue deferred payouts on a settlement event, and execute selected line items with lineItemIds.

6 endpointsGETPOST
📊

Transactions

Search, Detail & Exports

Search transactions for your MID, retrieve full detail, and export CSV or PDF reports for reconciliation and finance workflows.

6 endpointsGET
⚖️

Chargebacks

Dispute Visibility

List chargebacks and retrieve dispute detail for operations teams integrating chargeback status into internal dashboards.

2 endpointsGET
🏦

Reporting

Settlement & Transaction Reports

Pull transaction and settlement reports, and export breakdown and summary views for funding reconciliation.

6 endpointsGET

Match your use case to the right API

Accept card payments and manage saved cards
Payments API
Look up a sale by merchant order ID
Payments API
Void or refund a captured transaction
Payments API
Set up a disbursement workflow execution
Disbursements API
Continue deferred payouts or execute line items
Disbursements API
Search transactions and export reports
Transactions API
Monitor chargebacks and dispute detail
Chargebacks API
Reconcile settlements and transaction reports
Reporting API

Process a Card Payment

1

Capture the card payment through your checkout flow (QorPay processor).

2

Call the Public SDK to retrieve or persist the transaction by order ID.

3

Use Transactions APIs to search, export, refund, or void as your product requires.

4

Subscribe to merchant webhooks for asynchronous status updates where configured.

Run a Disbursement Workflow

1

List or get the disbursement workflow mapped to your MID.

2

Call Setup Workflow Execution (preferred). Do not use the deprecated Execute Workflow route for new integrations.

3

Continue execution with a settlement event for deferred payouts.

4

Call Execute Line Items with { lineItemIds } to pay selected deferred dynamic line items.

// Quickstart

Get started in 5 steps

01

Obtain integrator credentials

Request a CIP API key, organization ID, and ChainIT Pay MID from your platform administrator.

02

Configure your Public SDK base URL

Point requests at your sandbox or production API host. See Environments for base URLs.

03

Send required headers on every request

Include authorization (CIP key), x-organization-id, and x-chainitpay-mid-id on all /public-api/v1/* calls.

04

Make your first API request

Start with GET /public-api/v1/payment-methods or GET /public-api/v1/transaction/{orderId} to verify connectivity.

05

Explore the API Reference

Use the interactive OpenAPI explorer for request schemas, try-it requests, and module-specific endpoints.

terminal
# Step 3: Required headers
authorization: cip_<keyId>_<secret>
x-organization-id: <org-uuid>
x-chainitpay-mid-id: <mid-id>

# Step 4: List payment methods
$ curl -G /public-api/v1/payment-methods \
  -H "authorization: cip_..."
  -H "x-organization-id: ..."
  -H "x-chainitpay-mid-id: ..."

// Step 4: fetch example
const res = await fetch('/public-api/v1/payment-methods', { headers });

Ship payment integrations faster.

Explore the ChainIT Pay API Reference, configure CIP credentials, and start integrating card payments, transaction reporting, and disbursement workflows into your product.