Create Invoice

post

https://bank.sandbox.cybrid.app/api/invoices

Creates a invoice.

State

State	Description
storing	The Platform is storing the invoice details in our private store
unpaid	The invoice is unpaid. Payment instructions can be generated for an invoice in this state
cancelling	The invocie is in the process of being cancelled
cancelled	The invoice has been cancelled
settling	The invoice has been paid and the funds associated with this invoice are in the process of being settled
paid	The invoice has been paid and the funds associated with this invoice have been settled

Required scope: invoices:execute

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

asset

string

required

length between 1 and 16

The asset code the customer will receive the funds in.

customer_guid

string | null

The unique identifier for the customer.

receive_amount

integer

The amount to be received in base units of the asset, i.e., the amount the customer will receive after fees. ONLY one of receive_amount or deliver_amount is required.

deliver_amount

integer

The amount to be delivered in base units of the asset, i.e., the amount the customer will receive before fees. ONLY one of receive_amount or deliver_amount is required.

account_guid

string | null

The identifier for the account to use for the transfer. Required if the customer has multiple fiat accounts. Currently only valid for invoices paid to a fiat account.

labels

array of strings | null

The labels associated with the invoice.

labels

Responses

Language

Credentials

URL

Loading…

Response

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

application/json

201Invoice created

401Unauthorized - Authentication failed,

403Invalid scope

422Unprocessable Content