API reference
Fields and responses from the current OpenAPI contract.
OpenAPI contract
API version 0.9.0-draft · OpenAPI 3.1.0
All published paths
| Method | Path |
|---|---|
GET | /v1/workspaces/{workspaceID}/documents/customers |
POST | /v1/workspaces/{workspaceID}/documents/customers |
GET | /v1/workspaces/{workspaceID}/documents/customers/{documentID} |
PATCH | /v1/workspaces/{workspaceID}/documents/customers/{documentID} |
POST | /v1/workspaces/{workspaceID}/documents/customers/commands/import-preview |
POST | /v1/workspaces/{workspaceID}/documents/customers/commands/import |
POST | /v1/workspaces/{workspaceID}/documents/customers/commands/export |
GET | /v1/workspaces/{workspaceID}/documents/invoices |
POST | /v1/workspaces/{workspaceID}/documents/invoices |
GET | /v1/workspaces/{workspaceID}/documents/invoices/{documentID} |
PATCH | /v1/workspaces/{workspaceID}/documents/invoices/{documentID} |
POST | /v1/workspaces/{workspaceID}/documents/invoices/{documentID}/issue |
POST | /v1/workspaces/{workspaceID}/documents/invoices/{documentID}/cancel |
POST | /v1/workspaces/{workspaceID}/documents/invoices/{documentID}/correct |
POST | /v1/workspaces/{workspaceID}/documents/invoices/commands/export |
GET | /v1/workspaces/{workspaceID}/documents/payment-links |
POST | /v1/workspaces/{workspaceID}/documents/payment-links |
GET | /v1/workspaces/{workspaceID}/documents/payment-links/{documentID} |
PATCH | /v1/workspaces/{workspaceID}/documents/payment-links/{documentID} |
POST | /v1/workspaces/{workspaceID}/documents/payment-links/{documentID}/publish |
POST | /v1/workspaces/{workspaceID}/documents/payment-links/{documentID}/archive |
POST | /v1/workspaces/{workspaceID}/documents/payment-links/commands/export |
GET | /v1/workspaces/{workspaceID}/refunds |
POST | /v1/workspaces/{workspaceID}/refunds |
GET | /v1/workspaces/{workspaceID}/refunds/{refundID} |
POST | /v1/workspaces/{workspaceID}/refunds/{refundID}/review |
POST | /v1/workspaces/{workspaceID}/refunds/{refundID}/approve |
POST | /v1/workspaces/{workspaceID}/refunds/{refundID}/reject |
POST | /v1/workspaces/{workspaceID}/refunds/{refundID}/report-returned |
POST | /v1/workspaces/{workspaceID}/refunds/{refundID}/cancel |
GET | /v1/public/documents/{token} |
POST | /v1/public/documents/{token} |
POST | /v1/public/checkout/{token}/refunds |
GET | /v1/workspaces/{workspaceID}/reconciliation |
POST | /v1/workspaces/{workspaceID}/reconciliation/statement-preview |
POST | /v1/workspaces/{workspaceID}/reconciliation/statement-import |
POST | /v1/workspaces/{workspaceID}/reconciliation/settlement-link |
GET | /v1/workspaces/{workspaceID}/integrations |
POST | /v1/workspaces/{workspaceID}/integrations |
POST | /v1/workspaces/{workspaceID}/integrations/{integrationID}/enable |
POST | /v1/workspaces/{workspaceID}/integrations/{integrationID}/disable |
POST | /v1/workspaces/{workspaceID}/integrations/{integrationID}/edit |
GET | /v1/workspaces/{workspaceID}/activity/audit |
GET | /v1/workspaces/{workspaceID}/activity/api |
GET | /v1/workspaces/{workspaceID}/activity/exports |
GET | /v1/workspaces/{workspaceID}/reports |
GET | /v1/workspaces/{workspaceID}/notifications |
POST | /v1/workspaces/{workspaceID}/notifications/{notificationID}/read |
POST | /v1/workspaces/{workspaceID}/privacy/{requestID}/cancel |
GET | /v1/workspaces/{workspaceID}/workspace-tools/team |
GET | /v1/workspaces/{workspaceID}/workspace-tools/settings |
POST | /v1/workspaces/{workspaceID}/workspace-tools/settings |
GET | /v1/workspaces/{workspaceID}/workspace-tools/help |
POST | /v1/workspaces/{workspaceID}/workspace-tools/help |
GET | /v1/workspaces/{workspaceID}/privacy |
POST | /v1/workspaces/{workspaceID}/privacy |
GET | /v1/workspaces/{workspaceID}/billing |
POST | /v1/workspaces/{workspaceID}/billing |
POST | /v1/workspaces/{workspaceID}/billing/{invoiceID}/reconcile |
POST | /v1/workspaces/{workspaceID}/billing/free |
GET | /v1/platform/workspaces/{workspaceID}/payment-usage |
POST | /v1/workspaces/{workspaceID}/workspace-tools/invite |
POST | /v1/workspaces/{workspaceID}/workspace-tools/remove-member/{targetID} |
POST | /v1/workspaces/{workspaceID}/workspace-tools/change-role/{targetID} |
POST | /v1/workspaces/{workspaceID}/workspace-tools/revoke-invite/{targetID} |
POST | /v1/workspaces/{workspaceID}/workspace-tools/resend-invite/{targetID} |
POST | /v1/workspaces/{workspaceID}/workspace-tools/grants/{targetID} |
POST | /v1/workspaces/{workspaceID}/workspace-tools/transfer-owner/{targetID} |
POST | /v1/workspace-invites/accept-invite |
POST | /v1/workspaces/{workspaceID}/exports |
GET | /v1/workspaces/{workspaceID}/exports/{exportID} |
GET | /v1/workspaces/{workspaceID}/exports/{exportID}/download |
POST | /v1/public/documents/{token}/files |
GET | /v1/workspaces/{workspaceID}/sandbox/scenarios |
GET | /v1/workspaces/{workspaceID}/sandbox/runs |
POST | /v1/workspaces/{workspaceID}/sandbox/runs |
POST | /v1/workspaces/{workspaceID}/sandbox/reset |
POST | /v1/workspaces/{workspaceID}/documents/invoices/{documentID}/send |
POST | /v1/workspaces/{workspaceID}/documents/invoices/{documentID}/remind |
POST | /v1/public/checkout/{token}/notices/{noticeAction} |
GET | /v1/workspaces/{workspaceID}/operations/{resource} |
POST | /v1/workspaces/{workspaceID}/operations/{resource} |
GET | /v1/workspaces/{workspaceID}/operations/{resource}/{resourceID} |
POST | /v1/workspaces/{workspaceID}/operations/{resource}/{resourceID}/{action} |
POST | /v1/device/{action} |
GET | /healthz |
GET | /readyz |
GET | /v1/merchant/context |
GET | /v1/workspaces/{workspaceID}/linked-sources |
POST | /v1/workspaces/{workspaceID}/linked-sources |
POST | /v1/payment/create |
POST | /v1/payment/verify |
GET | /v1/payment-intents |
POST | /v1/payment-intents |
GET | /v1/payment-intents/{intentID} |
POST | /v1/payment-intents/{intentID}/cancel |
POST | /v1/payment-intents/{intentID}/verify-transaction |
GET | /v1/workspaces/{workspaceID}/payment-intents |
POST | /v1/workspaces/{workspaceID}/payment-intents |
GET | /v1/workspaces/{workspaceID}/payment-intents/{intentID} |
POST | /v1/workspaces/{workspaceID}/payment-intents/{intentID}/cancel |
GET | /v1/public/checkout/{token} |
POST | /v1/public/checkout/{token}/lock |
Create payment
POST
/v1/payment/createpayments:write| Field | Type | Required | Description |
|---|---|---|---|
amount | number | Yes | Amount in taka (BDT), up to two decimal places. |
redirect_url | uri | No | Public HTTPS return page after payment. |
webhook_url | uri | No | Public HTTPS URL for signed payment alerts. |
cancel_url | uri | No | Public HTTPS return page after cancellation. |
reference | string | No | Your order reference; generated if omitted. |
customer_name | string | No | Customer name. |
customer_email | string | No | Customer email address. |
customer_phone | string | No | Contact number; not payment proof. |
metadata | object | No | Order details; never include secrets. |
Verify payment
POST
/v1/payment/verifypayments:read| Field | Type | Required | Description |
|---|---|---|---|
invoice_id | uuid | Yes | The invoice_id returned by Create payment. |
Response units
Requests use amount in taka. The current Verify response contract still returns amount_minor in paisa: 15000 means ৳150.00. Convert your stored order amount to the same unit before comparing; this portal does not change the API contract.
200 OK
{
"invoice_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "COMPLETED",
"amount_minor": 15000,
"currency": "BDT",
"reference": "ORDER-123"
}Not published yet
- TODO: configure the public custom API origin.
- TODO: publish the guaranteed idempotency retention period.