Skip to main content
GET
Get Bill Status

Request Headers

string
required
Bearer token for authentication. Format: Bearer <token>
string
default:"application/json"
Expected response format. Use application/json.

Path Parameters

string
required
The unique UUID of the bill transaction (e.g. 5f8b789f-e6e6-4506-91be-cb344009c680).

Response

boolean
Indicates whether the request was successful.
string
A human-readable status message.
string
The unique UUID of the transaction.
string
Current status of the bill. Possible values: pending,partial,settled,cancelled
  • pending : no records of any payment activity
  • partial : the bill has started receiving payments (only applicable to flexible bills)
  • settled : the bill has received the full amount
  • cancelled : the bill has been cancelled (only bills with no payment activity can be cancelled)
object
The original bill information.
object
Breakdown of the transaction amounts.
object
Additional key-value pairs associated with the bill.
string | null
ISO 8601 timestamp of when the bill was settled. null if not yet settled.
string
ISO 8601 timestamp of when the bill was created.
string
ISO 8601 timestamp of when this response was generated.