Skip to main content

Callback handler example and information

We will call your callback_url whenever there's an update to invoice status and/or new payment for the invoice.

Responses
default

invoice

Schema
id string — REQUIRED

Invoice id

url string — REQUIRED

Invoice URL

amount float — REQUIRED
paid_amount float
prices object[]
base_currency string — REQUIRED
name string
description string
account_name string
status string — REQUIRED

pending: If the payment of the invoice is not received, then the invoice status is shown as "pending". It will be initial status when the invoice is created.

paid: When invoice is received full amount, invoice status will be shown as "paid".

under paid: If the payment of the invoice has been paid in part, the invoice status is shown as "under paid".

over paid: f the payment of the invoice is greater than amount value, the status of the invoice is shown as "overpaid".

expired: if the payment of the invoice does not complete before the expiry time, the status of the invoice is shown as "expired".

cancelled: if customer cancels the invoice, the status of the invoice is shown as "cancelled".

status_code integer — REQUIRED

0: Pending

1: Paid

2: Underpaid

3: Over Paid

4: Expired

5: Cancelled

notify_url string
suceess_url string
fail_url string
expires_on

Invoice expiration time in RFC3339 format

payments undefined[]
tx_hash string
explorer_url string
amount float
date string

Invoice creation time in RFC3339 format

confirmation integer
created_at string — REQUIRED

Invoice creation time in RFC3339 format

updated_at string

Last updated time in RFC3339 format

meta_data1 string
meta_data2 string