Skip to main content
Transact Bridge provides APIs to manage the complete invoice lifecycle. Merchants can retrieve individual invoices, retrieve multiple invoices, update and approve draft invoices, process refunds, and email invoices to customers.

​
Invoice Operations

​
Invoice Lifecycle

The following flow illustrates the typical invoice management lifecycle.

​
1. Get Invoice

Use the Get Invoice API to retrieve the details of a specific invoice. This can be used when the merchant needs to:
  • Retrieve invoice details.
  • Check the invoice status.
  • View invoice amount and currency.
  • Retrieve customer and billing information.
  • Check payment or transaction details associated with the invoice.

​
2. Get All Invoice

Use the Get All Invoice API to retrieve invoices associated with the merchant. This can be used when the merchant needs to:
  • Display invoices in an internal dashboard.
  • Retrieve multiple invoices.
  • Track invoice statuses.
  • Search or manage invoice records.

​
3. Update Draft Invoice

Use the Update Draft Invoice API to modify an invoice while it is in the DRAFT state. A merchant can use this API when invoice details need to be updated before the invoice is approved.

​
Typical Use Cases

  • Update the invoice amount based on actual usage.
  • Add or modify billing information.
  • Update invoice items.
  • Apply the final billing amount before approval.
Draft invoice details should be updated before the invoice is approved. Once the invoice has progressed beyond the draft stage, the applicable invoice update rules apply.

​
4. Approve Draft Invoice

Use the Approve Draft Invoice API to approve a draft invoice after the merchant has completed the required updates. Once approved, the invoice can proceed to the applicable payment collection process.

​
Example Scenario

For a postpaid subscription, the merchant may receive the customer’s usage information after the billing period. For example: The merchant can update the draft invoice with the final amount and then approve it for collection.

​
5. Refund Invoice

Use the Refund Invoice API when the merchant needs to refund a payment associated with an invoice.

​
Typical Use Cases

  • Customer requests a refund.
  • Order or service is cancelled.
  • Duplicate payment.
  • Incorrect amount charged.
  • Merchant decides to provide a full or applicable partial refund.

​
Refund Flow

The refund amount and applicable refund rules should follow the parameters and business rules defined for the Refund Invoice API.

​
6. Email Invoice

Use the Email Invoice API to send an invoice to the customer through email. This can be used when the merchant wants to:
  • Send an invoice to the customer’s registered email address.
  • Resend an invoice.
  • Provide the customer with invoice details after payment.
  • Share an invoice for record-keeping purposes.

​
Email Flow