Create an invoice

curl --request POST \
  --url https://app.ca.cryptoprocessing.com/api/v2/invoices/create \
  --header 'Content-Type: application/json' \
  --header 'X-Processing-Key: <api-key>' \
  --header 'X-Processing-Signature: <x-processing-signature>' \
  --data '
{
  "timer": false,
  "title": "Invoice Title",
  "currency": "USD",
  "amount": 100,
  "foreign_id": "invoice_123",
  "end_user_reference": "user_12345",
  "url_success": "https://example.com/success",
  "url_failed": "https://example.com/failed",
  "email_user": "chris.customer@example.com",
  "sender_type": "natural",
  "sender_data": {
    "first_name": "Chris",
    "last_name": "Customer",
    "date_of_birth": "1970-01-01"
  }
}
'

{
  "data": {
    "id": 826900,
    "url": "https://invoices.ca.cryptoprocessing.com/invoice/Jyf1cQ",
    "foreign_id": "invoice_123",
    "end_user_reference": "user_12345",
    "address": null,
    "title": "Invoice Title",
    "status": "created",
    "currency": "USD",
    "amount": "100.00000000",
    "sender_currency": null,
    "sender_amount": null,
    "fixed_at": null,
    "release_at": null,
    "seconds_left": null
  }
}

POST

invoices

create

curl --request POST \
  --url https://app.ca.cryptoprocessing.com/api/v2/invoices/create \
  --header 'Content-Type: application/json' \
  --header 'X-Processing-Key: <api-key>' \
  --header 'X-Processing-Signature: <x-processing-signature>' \
  --data '
{
  "timer": false,
  "title": "Invoice Title",
  "currency": "USD",
  "amount": 100,
  "foreign_id": "invoice_123",
  "end_user_reference": "user_12345",
  "url_success": "https://example.com/success",
  "url_failed": "https://example.com/failed",
  "email_user": "chris.customer@example.com",
  "sender_type": "natural",
  "sender_data": {
    "first_name": "Chris",
    "last_name": "Customer",
    "date_of_birth": "1970-01-01"
  }
}
'

{
  "data": {
    "id": 826900,
    "url": "https://invoices.ca.cryptoprocessing.com/invoice/Jyf1cQ",
    "foreign_id": "invoice_123",
    "end_user_reference": "user_12345",
    "address": null,
    "title": "Invoice Title",
    "status": "created",
    "currency": "USD",
    "amount": "100.00000000",
    "sender_currency": null,
    "sender_amount": null,
    "fixed_at": null,
    "release_at": null,
    "seconds_left": null
  }
}

Documentation for invoices: Overview, Fees, Create invoice, Cancel invoice, Callbacks.For new integrations, consider migrating to payment requests instead.

CryptoProcessing is required to collect sender data in compliance with local regulations. For more details, see User data collection. The sender_data and the end_user_reference you provide must be associated with the same customer.

Errors

400 Bad Request

Error message	What it means
`foreign_id: The foreign id has already been taken.`	The `foreign_id` was already used by one of your invoices. The check is case-insensitive. Use a new `foreign_id`.
`currency: The selected currency is invalid.`	The `currency` code doesn’t exist. See API currency codes.
`sender_currency: Currency is invalid or unavailable`	The `sender_currency` code doesn’t exist. `sender_currency` is the same as `currency`. To pre-select a payment currency, use a currency other than `currency`. `sender_currency` is a fiat currency. The customer pays in a cryptocurrency.
`timer: The timer has to be set up in case sender currency is defined`	`sender_currency` was sent with `timer` set to `false`. An invoice with a pre-selected payment currency needs `timer: true`.
`timer: The timer field must be true or false.`	`timer` isn’t a boolean, for example the string `"true"`.
`amount: The amount must be a number.`	`amount` isn’t a number or a numeric string.
`amount: The amount is too small. The minimum amount is <amount> <currency>.`	The amount is below the minimum invoice amount, or is zero or negative. `<amount> <currency>` is the minimum, which can be stated in another currency than the invoice’s. The invoice amount, converted to `sender_currency`, is below that currency’s minimum. `<amount> <currency>` is the minimum, in `sender_currency`.
`amount: The amount is too large. The one-time operation limit is <amount> <currency>.`	The amount is above the maximum invoice amount. `<amount> <currency>` is the maximum, which can be stated in another currency than the invoice’s.
`amount: The number of decimal places needs to be less than 8`	`amount` has more than 8 decimal places.
`url_success: The url success format is invalid.`	`url_success` isn’t a valid URL.
`url_failed: The url failed format is invalid.`	`url_failed` isn’t a valid URL.
`title: The title may not be greater than 50 characters.`	`title` is longer than 50 characters.
`description: The description may not be greater than 1000 characters.`	`description` is longer than 1000 characters.
`foreign_id: The foreign id may not be greater than 255 characters.`	`foreign_id` is longer than 255 characters.
`end_user_reference: The end user reference may not be greater than 255 characters.`	`end_user_reference` is longer than 255 characters.
`title: The title must be a string.`	`title` was sent as another JSON type, such as a number.
`description: The description must be a string.`	`description` was sent as another JSON type, such as a number, or as an empty string. Leave it out instead of sending an empty string.
`currency: The currency must be a string.`	`currency` was sent as another JSON type, such as a number.
`sender_currency: The sender currency must be a string.`	`sender_currency` was sent as another JSON type, such as a number.
`foreign_id: The foreign id must be a string.`	`foreign_id` was sent as another JSON type, such as a number. Send it as a string.
`end_user_reference: The end user reference must be a string.`	`end_user_reference` was sent as another JSON type, such as a number.
`end_user_reference: The end user reference must not contain email.`	`end_user_reference` contains an email address. Use an ID from your system that contains no personal data.
`email_user: The email user must be a valid email address.`	`email_user` isn’t a valid email address.
`timer: The timer field is required.`	`timer` is missing, `null` or an empty string.
`title: The title field is required.`	`title` is missing, `null`, an empty string, or only spaces.
`foreign_id: The foreign id field is required.`	`foreign_id` is missing, `null` or an empty string.
`currency: The currency field is required.`	`currency` is missing, `null` or an empty string.
`amount: The amount field is required.`	`amount` is missing, `null` or an empty string.
`url_success: The url success field is required.`	`url_success` is missing, `null` or an empty string.
`url_failed: The url failed field is required.`	`url_failed` is missing, `null` or an empty string.
`email_user: The email user field is required.`	`email_user` is missing, `null` or an empty string.
`type: The selected type is invalid.`	`type` isn’t `fill_or_kill` or `good_until_expired`.
`Required features [invoices_enabled] not enabled.`	Invoices aren’t enabled for your merchant account.

422 Unprocessable Entity

Error message	What it means
`Something went wrong. Please try later.` (code `internal_error`)	`amount` was sent as a string in scientific notation, such as `"1e1"`. Send it in plain decimal notation, such as `"10"`. For other causes of this error, see Internal error.

Authorizations

X-Processing-Key

string

header

required

Your API key.

Headers

X-Processing-Signature

string

required

Hex-encoded HMAC-SHA512 signature of the request body, generated using your secret key.

Body

application/json

end_user_reference

string

required

Permanent ID of the customer in your system. Used to group, track, and analyze transactions made by a specific customer. Must not contain personal data, such as the user's name or email address.

timer

boolean

required

If this parameter is set to true, the invoice will expire in 15 minutes after it is created.

title

string

required

Invoice title that the customer will see.

Required string length: 1 - 50

foreign_id

string

required

Unique ID of the invoice in your system, case-insensitive. Avoid / and #: the cancel endpoint takes the foreign_id in its path and can't find an invoice whose foreign_id contains them.

Maximum string length: 255

currency

string

required

Currency you want to receive deposits in. For a list of all available currencies, see API currency codes.

amount

required

The invoice amount you want to receive from the customer, in currency, as a number or a decimal string, with at most 8 decimal places. It must be within the minimum and maximum invoice amounts.

url_success

string<uri>

required

The URL the customer will be redirected to in case of a successful invoice payment.

url_failed

string<uri>

required

The URL the customer will be redirected to in case of an unsuccessful invoice payment.

email_user

string<email>

required

The customer's email address. It's filled in for the customer on the invoice page. The customer gets an email when the invoice is paid, and when a payment doesn't match the invoice (more or less than the invoice amount, a payment after the invoice has expired or failed, or a payment to an invoice you cancelled): either a link to claim a refund, or a notice that the amount is too small to be refunded.

sender_type

enum<string>

required

Type of the merchant's customer who sends the funds.

Use natural if the sender is an individual person and legal if the sender is a legal entity. The selected type determines which fields must be included in sender_data.

Available options:

natural,

legal

sender_data

Natural person · object

required

Must contain the details of the merchant's customer who sends the funds. Which fields are required depends on sender_type.

Natural person
Legal entity

Hide child attributes

sender_data.first_name

string

required

The sender's first name.

Maximum string length: 255

sender_data.last_name

string

required

The sender's last name.

Maximum string length: 255

sender_data.date_of_birth

string

The sender's date of birth, YYYY-MM-DD. Optional for a natural person.

type

enum<string>

For partial pay invoices, set this parameter to good_until_expired. For standard invoices, use fill_or_kill or leave this empty. See Partial pay invoices.

Available options:

fill_or_kill,

good_until_expired

description

string

Invoice description that the customer will see.

Maximum string length: 1000

sender_currency

string

Currency the customer will pay in. Requires timer: true (otherwise the request fails with The timer has to be set up in case sender currency is defined). The invoice is then created with a fixed payment currency, rate and address, and the response includes address, sender_amount and fixed_at. Must be a cryptocurrency different from currency.

Response

Created

data

object

Hide child attributes

data.id

integer

required

Invoice ID.

Example:

123732

data.url

string<uri>

required

Invoice URL.

data.foreign_id

string

required

This invoice's unique ID in your system.

data.end_user_reference

string

required

The unique ID of the customer this invoice is for. You can use it to group invoices by customer.

data.address

string | null

required

The address the customer pays to. Assigned right away for invoices created with sender_currency; otherwise null until the customer chooses a payment currency on the invoice page.

Example:

"2N2xtaZCNygY3iq6XKPJsdoPMDX85LUc8SM"

data.title

string

required

Invoice title.

Minimum string length: 1

data.status

enum<string>

required

pending for invoices with a timer, created for invoices without one.

Available options:

created,

pending

data.currency

string

required

Invoice currency.

data.amount

string

required

Invoice amount.

Example:

"0.01230000"

data.sender_currency

string | null

required

The currency the customer will pay in. null for invoices without a pre-selected currency.

data.sender_amount

string | null

required

The amount the customer needs to pay in sender_currency. null for invoices without a pre-selected currency.

Example:

"0.01230000"

data.fixed_at

integer | null

required

Unix time in seconds when the payment rate was fixed. For invoices with a pre-selected currency, this is the creation time. Otherwise it's null, and the rate is fixed later, when the customer chooses a payment currency on the invoice page.

data.release_at

integer | null

required

Unix time in seconds when the invoice will expire. null for invoices without a timer.

data.seconds_left

integer | null

required

The number of seconds left until the invoice expires. null for invoices without a timer.

Example:

899

data.tag

string | null

Destination tag/memo. Present only for currencies that support tags (e.g., XRP).

Last modified on October 29, 2026

Reference

Deposits

Withdrawals

Payment requests

Exchanges

Currencies

Transactions

Account balance

System Health

Authorizations

Headers

Body

Response