Cancel embedded card charge
Cancel embedded card charge
Overview
Cancel embedded card charge
Cancels a card charge before completion.
When to use this
Use when the buyer abandons checkout.
See also
Authentication
Merchant routes require an API key in the X-API-KEY header (see Integration overview). Use a test key against https://sandbox.api.lomi.africa and a live key against https://api.lomi.africa.
Endpoint
POST /charge/card/{id}/cancel
Base URLs:
https://sandbox.api.lomi.africahttps://api.lomi.africa
Request
Path parameters
| Name | Required | Schema | Description |
|---|---|---|---|
id | Yes | - | Card payment id (pi_...) |
Query parameters
No query parameters.
Headers
| Name | In | Required | Schema | Description |
|---|---|---|---|---|
Lomi-Account | header | No | - | Optional lomi. Network account id (acct_...). When present, the API key acts as the Operator and the request targets the connected Member Account. |
Request body
No application/json body for this operation.
Responses
| Status | Description |
|---|---|
200 | Card charge cancelled |
Errors
Errors follow the standard JSON error format (status code and machine-readable message). Validate inputs before calling; 401 indicates a missing/invalid key, 404 a missing resource for this organization, 429 rate limiting. For safe retries on create-style calls, send an idempotency key when your flow supports it.
Example
curl -sS -X POST "https://sandbox.api.lomi.africa/charge/card/value/cancel" \
-H "X-API-KEY: $LOMI_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{}'OpenAPI
- operationId:
ChargesController_cancelCardCharge - Operation:
POST /charge/card/{id}/cancel
Full schemas and Try it: API reference. Machine-readable contract: repo apps/docs/openapi.json.