Create Billing Request

post

https://api.coingate.com/api/v2/billing/requests

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Creates a new billing request and returns a payment link that can be shared with a customer. Billing requests are typically used to send one-off crypto payment links to customers outside of a full shopping cart experience.

Time-Based Behaviors:

Billing Request

The pay button on the billing link is disabled if:

The due_days period has expired, or
The associated invoice is already paid.

Invoice

Invoice is valid for 2 hours unless payment details are generated.
- Once the customer reaches the payment details view, they have a fixed window of 20 minutes to complete the payment

Body Params

billing_contact_id

int32

required

Billing Contact ID

title

string

Request title

currency_id

int32

required

Currency of amount. Currency ID's can be seen on https://developer.coingate.com/reference/currencies

amount

string

Amount is required only when the request is created without associated products. If products are included, the amount is automatically calculated based on the product prices and quantities

receive_currency_id

int32

required

Currency ID's can be seen on https://developer.coingate.com/reference/currencies

due_days

int32

Defaults to 0

Defines how many days the pay button remains active. Default: 0 won't expire. Example: A value of 3 means the pay button will remain active for 3 days after billing request has been created

send_email

boolean

Defaults to true

Will billing contact receive email about reqeust.

underpaid_cover_pct

string

Defaults to 0

How much percentage of underpaid can be covered.

callback_url

string

Send an automated message to Merchant URL when request status is changed. For testing you can use requestcatcher.com tool. URL must be direct without redirection. Read about billing request callbacks here.

billing_request_items

object

Billing Products and quantity. If present amount will calculated based on product price and quantity.

Responses

200200

422422