Create a Bill

Facades: pos, merchant

Body Params
string

Bill identifier, specified by merchant

string
required

ISO 4217 3-character currency code. This is the currency associated with the price field

string

Bill recipient's name

string

Bill recipient's address

string

Bill recipient's address

string

Bill recipient's city

string

Bill recipient's state or province

string

Bill recipient's ZIP code

string

Bill recipient's country

string

Bill recipient's email address

cc
array of strings

Email addresses to which a copy of the bill must be sent

cc
string

Bill recipient's phone number

string

Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ. (UTC)

boolean

If set to true, BitPay's processing fee will be included in the amount charged on the invoice

items
array of objects
required

List of line items

items*
string
required

The API token can be retrieved from the dashboard (limited to pos facade) or using the Tokens resource to get access to the merchant facade. This is described in the section Request an API token).

Headers
string
required
Defaults to application/json

Must be set to application/json for requests to the BitPay API

string
required
Defaults to 2.0.0

Must be set to 2.0.0 for requests to the BitPay API

string

The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a merchant facade token.

string

The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a merchant facade token.

Response

Language
LoadingLoading…
Response
Choose an example:
application/json