Create charge

post

https://api.opennode.com/v1/charges

Body Params

amount

int32

required

Amount intended to be collected. The default currency is in 'satoshis', specify 'currency' param for fiat amounts

currency

string

Three-letter ISO currency code, in uppercase. If specified will generate a charge for the equivalent amount of BTC at the current exchange rates

description

string

Description to be shown in the payer's wallet

customer_name

string

Payer's name

customer_email

string

Payer's email

order_id

string

Order ID for merchant's internal use

callback_url

string

URL to receive webhooks for payment status updates

success_url

string

URL to redirect user after successful payment

auto_settle

boolean

Automatically convert payment to fiat (requires bank wallet setup)

split_to_btc_bps

int32

Keep a percentage (in bps) of the payment in BTC

ttl

int32

TTL (time to live) in minutes. Min: 10, Max: 4320 (72H), Default: 1440

notify_receiver

boolean

Defaults to false

Notify receiver (you) via email when this checkout is paid

Headers

Content-Type

string

required

Defaults to application/json

Content-type header

Authorization

string

required

Api key

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400