Show an invoice (by custom_id)
get
https://business-sandbox.cryptopay.me
/api/invoices/custom_id/:custom_id
Show an invoice by custom_id
Response schema.
Parameter
Type
Description
id
string
Invoice ID
custom_id
string
Invoice reference ID in your system
status
string
Invoice status. Refer to the invoice statuses section
status_context
string
Invoice status context. Refer to the invoice statuses section
address
string
Invoice cryptocurrency address
uri
string
Invoice URI. May be used for generating a QR code
price_amount
string
Invoice amount
price_currency
string
Invoice amount currency. Refer to a list of supported currencies
pay_amount
string
Cryptocurrency amount to pay
pay_currency
string
Cryptocurrency type
fee
string
Processing fee
fee_currency
string
Processing fee currency
paid_amount
string
Transaction amount that has been received
exchange
object
Exchange details
pair
string
Currency pair
rate
string
Exchange rate
fee
string
Exchange fee
fee_currency
string
Exchange fee currency
transactions
object
Cryptocurrency transaction hash and its risk level details
txid
string
Transaction hash
risk
object
Transaction risk level details
score
number
Transaction risk score
level
string
Transaction risk level. low, medium or high depending on the score value
resource_name
string
A resource name the transaction has been received from e.g. Bitstamp
resource_category
string
A resource category the transaction has been received from e.g. Exchange
name
string
Invoice name
description
string
Invoice description
metadata
object
Key-value data
success_redirect_url
string
URL that a customer will be redirected to upon transaction confirmation
hosted_page_url
string
Invoice hosted page that renders invoice details
created_at
string
Invoice creation date and time
expires_at
string
Invoice expiration date and time
Last modified 2yr ago
Copy link