Easy Labs
APIAccount & operationsBill pay

Cancel a bill submission

Cancel a bill. A linked treasury transaction is also cancelled if it has not yet been submitted to Brale.

POST
/v1/api/billpay/{id}/cancel

Authorization

apiKey
x-easy-api-key<token>

Merchant API key. Publishable keys (pk_test_* / pk_live_) are safe for browser/frontend use and carry a limited scope set (sessions, payment_instruments, customers, orders writes; products, product_prices, payment_links reads). Secret keys (sk_test_ / sk_live_*) grant full admin access and must only be used server-side.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/v1/api/billpay/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"
{
  "success": true,
  "timestamp": "2019-08-24T14:15:22Z",
  "data": null,
  "message": "string",
  "pagination": {
    "total": 0,
    "limit": 1,
    "offset": 0,
    "has_more": true,
    "truncated": true,
    "cursors": {
      "first": "string",
      "last": "string"
    }
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}

Upload a bill for processing

Upload a bill document (PDF, PNG, JPEG, WebP) via multipart/form-data with field name `file`. The file is stored and extracted; the bill is returned ready for review.

Confirm a bill payment 2FA challenge

Submit the 2FA code (and the transaction_id returned by /confirm) to finish a payment that required two-factor authentication. On success the bill moves to processing and the payment is submitted to Brale.