Invoice API

API for invoices

Get a specific Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Response with invoice data

idstringRequired

Invoice id

invoiceAddressstringRequired

Crypto address for deposit

typestring · enumRequired

The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters

Possible values:

amountnumberOptional

Amount of the invoice

feenumberOptional

Service fee for invoice. This amount will be deducted from invoice amount

totalDebitAmountnumberRequired

The total amount of money received on the invoice wallet

currencystringRequired

Currency of the invoice

statestring · enumRequired

Status of the invoice

Possible values:

lastDepositHashstringOptional

Hash of the last deposit transaction to the invoice

descriptionstringRequired

Short invoice description

createdDatestring · date-timeRequired

Time of invoice creation

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the invoice

expirationstring · date-timeOptional

Server timestamp of invoice expiration moment

fiatAmountnumberOptional

Amount of fiat money set for SINGLE_FIAT_INVOICE

fiatCurrencystringOptional

Currency of featAmount

lastFiatUpdatedstring · date-timeOptional

Time when the exchange rate was updated last time in SINGLE_FIAT invoices

interventionTypestring · enumOptional

Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount

Possible values:

isInterventionResolvedbooleanRequired

Represents whether the intervention was resolved or not (set by user)

subscriptionEnabledbooleanRequired

Represents whether client subscribed on email notifications or not

returnUrlstringOptional

Link to the web page where client can come back to from payment link (page with invoice data for payment)

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px

supportUrlstringOptional

Link to the merchant support page where client can go to from payment link (page with invoice data for payment)

externalIdstringOptional

Merchant ID that can be assigned to invoice or several invoices in string format

lowerBoundnumberOptional

Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored

fiatAvailablebooleanRequired

Fiat available

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice

HTTPcURLJavaScriptPython

POST /api/v1/invoice HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "id": "text",
  "invoiceAddress": "text",
  "type": "SINGLE",
  "amount": 1,
  "fee": 1,
  "totalDebitAmount": 1,
  "currency": "text",
  "state": "MEM_POOL_FOUND",
  "lastDepositHash": "text",
  "description": "text",
  "createdDate": "2026-03-05T00:03:46.727Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2026-03-05T00:03:46.727Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2026-03-05T00:03:46.727Z",
  "interventionType": "OVERPAY",
  "isInterventionResolved": true,
  "subscriptionEnabled": true,
  "returnUrl": "text",
  "logoUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "lowerBound": 1,
  "autoconversion": {
    "targetCurrency": "text",
    "amount": 1
  },
  "fiatAvailable": true
}

New Unlimited Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Response with invoice data

idstringRequired

Invoice id

invoiceAddressstringRequired

Crypto address for deposit

typestring · enumRequired

The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters

Possible values:

amountnumberOptional

Amount of the invoice

feenumberOptional

Service fee for invoice. This amount will be deducted from invoice amount

totalDebitAmountnumberRequired

The total amount of money received on the invoice wallet

currencystringRequired

Currency of the invoice

statestring · enumRequired

Status of the invoice

Possible values:

lastDepositHashstringOptional

Hash of the last deposit transaction to the invoice

descriptionstringRequired

Short invoice description

createdDatestring · date-timeRequired

Time of invoice creation

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the invoice

expirationstring · date-timeOptional

Server timestamp of invoice expiration moment

fiatAmountnumberOptional

Amount of fiat money set for SINGLE_FIAT_INVOICE

fiatCurrencystringOptional

Currency of featAmount

lastFiatUpdatedstring · date-timeOptional

Time when the exchange rate was updated last time in SINGLE_FIAT invoices

interventionTypestring · enumOptional

Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount

Possible values:

isInterventionResolvedbooleanRequired

Represents whether the intervention was resolved or not (set by user)

subscriptionEnabledbooleanRequired

Represents whether client subscribed on email notifications or not

returnUrlstringOptional

Link to the web page where client can come back to from payment link (page with invoice data for payment)

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px

supportUrlstringOptional

Link to the merchant support page where client can go to from payment link (page with invoice data for payment)

externalIdstringOptional

Merchant ID that can be assigned to invoice or several invoices in string format

lowerBoundnumberOptional

Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored

fiatAvailablebooleanRequired

Fiat available

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/unlimited/create

HTTPcURLJavaScriptPython

POST /api/v1/invoice/unlimited/create HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "currency": "text",
    "description": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "returnUrl": "text",
    "logoUrl": "text",
    "supportUrl": "text",
    "externalId": "text",
    "fiatAvailable": true
  }
}

{
  "id": "text",
  "invoiceAddress": "text",
  "type": "SINGLE",
  "amount": 1,
  "fee": 1,
  "totalDebitAmount": 1,
  "currency": "text",
  "state": "MEM_POOL_FOUND",
  "lastDepositHash": "text",
  "description": "text",
  "createdDate": "2026-03-05T00:03:46.727Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2026-03-05T00:03:46.727Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2026-03-05T00:03:46.727Z",
  "interventionType": "OVERPAY",
  "isInterventionResolved": true,
  "subscriptionEnabled": true,
  "returnUrl": "text",
  "logoUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "lowerBound": 1,
  "autoconversion": {
    "targetCurrency": "text",
    "amount": 1
  },
  "fiatAvailable": true
}

New Unlimited Linked Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Response with invoice data

idstringRequired

Invoice id

invoiceAddressstringRequired

Crypto address for deposit

typestring · enumRequired

The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters

Possible values:

amountnumberOptional

Amount of the invoice

feenumberOptional

Service fee for invoice. This amount will be deducted from invoice amount

totalDebitAmountnumberRequired

The total amount of money received on the invoice wallet

currencystringRequired

Currency of the invoice

statestring · enumRequired

Status of the invoice

Possible values:

lastDepositHashstringOptional

Hash of the last deposit transaction to the invoice

descriptionstringRequired

Short invoice description

createdDatestring · date-timeRequired

Time of invoice creation

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the invoice

expirationstring · date-timeOptional

Server timestamp of invoice expiration moment

fiatAmountnumberOptional

Amount of fiat money set for SINGLE_FIAT_INVOICE

fiatCurrencystringOptional

Currency of featAmount

lastFiatUpdatedstring · date-timeOptional

Time when the exchange rate was updated last time in SINGLE_FIAT invoices

interventionTypestring · enumOptional

Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount

Possible values:

isInterventionResolvedbooleanRequired

Represents whether the intervention was resolved or not (set by user)

subscriptionEnabledbooleanRequired

Represents whether client subscribed on email notifications or not

returnUrlstringOptional

Link to the web page where client can come back to from payment link (page with invoice data for payment)

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px

supportUrlstringOptional

Link to the merchant support page where client can go to from payment link (page with invoice data for payment)

externalIdstringOptional

Merchant ID that can be assigned to invoice or several invoices in string format

lowerBoundnumberOptional

Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored

fiatAvailablebooleanRequired

Fiat available

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/unlimited-linked/create

HTTPcURLJavaScriptPython

POST /api/v1/invoice/unlimited-linked/create HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "currency": "text",
    "description": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "returnUrl": "text",
    "logoUrl": "text",
    "supportUrl": "text",
    "externalId": "text",
    "fiatAvailable": true
  }
}

{
  "id": "text",
  "invoiceAddress": "text",
  "type": "SINGLE",
  "amount": 1,
  "fee": 1,
  "totalDebitAmount": 1,
  "currency": "text",
  "state": "MEM_POOL_FOUND",
  "lastDepositHash": "text",
  "description": "text",
  "createdDate": "2026-03-05T00:03:46.727Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2026-03-05T00:03:46.727Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2026-03-05T00:03:46.727Z",
  "interventionType": "OVERPAY",
  "isInterventionResolved": true,
  "subscriptionEnabled": true,
  "returnUrl": "text",
  "logoUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "lowerBound": 1,
  "autoconversion": {
    "targetCurrency": "text",
    "amount": 1
  },
  "fiatAvailable": true
}

New Single Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Response with invoice data

idstringRequired

Invoice id

invoiceAddressstringRequired

Crypto address for deposit

typestring · enumRequired

The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters

Possible values:

amountnumberOptional

Amount of the invoice

feenumberOptional

Service fee for invoice. This amount will be deducted from invoice amount

totalDebitAmountnumberRequired

The total amount of money received on the invoice wallet

currencystringRequired

Currency of the invoice

statestring · enumRequired

Status of the invoice

Possible values:

lastDepositHashstringOptional

Hash of the last deposit transaction to the invoice

descriptionstringRequired

Short invoice description

createdDatestring · date-timeRequired

Time of invoice creation

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the invoice

expirationstring · date-timeOptional

Server timestamp of invoice expiration moment

fiatAmountnumberOptional

Amount of fiat money set for SINGLE_FIAT_INVOICE

fiatCurrencystringOptional

Currency of featAmount

lastFiatUpdatedstring · date-timeOptional

Time when the exchange rate was updated last time in SINGLE_FIAT invoices

interventionTypestring · enumOptional

Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount

Possible values:

isInterventionResolvedbooleanRequired

Represents whether the intervention was resolved or not (set by user)

subscriptionEnabledbooleanRequired

Represents whether client subscribed on email notifications or not

returnUrlstringOptional

Link to the web page where client can come back to from payment link (page with invoice data for payment)

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px

supportUrlstringOptional

Link to the merchant support page where client can go to from payment link (page with invoice data for payment)

externalIdstringOptional

Merchant ID that can be assigned to invoice or several invoices in string format

lowerBoundnumberOptional

Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored

fiatAvailablebooleanRequired

Fiat available

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/single/create

HTTPcURLJavaScriptPython

POST /api/v1/invoice/single/create HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 287

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "expiration": "2026-03-05T00:03:46.727Z",
    "amount": 1,
    "currency": "text",
    "description": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "returnUrl": "text",
    "logoUrl": "text",
    "supportUrl": "text",
    "externalId": "text",
    "fiatAvailable": true
  }
}

{
  "id": "text",
  "invoiceAddress": "text",
  "type": "SINGLE",
  "amount": 1,
  "fee": 1,
  "totalDebitAmount": 1,
  "currency": "text",
  "state": "MEM_POOL_FOUND",
  "lastDepositHash": "text",
  "description": "text",
  "createdDate": "2026-03-05T00:03:46.727Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2026-03-05T00:03:46.727Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2026-03-05T00:03:46.727Z",
  "interventionType": "OVERPAY",
  "isInterventionResolved": true,
  "subscriptionEnabled": true,
  "returnUrl": "text",
  "logoUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "lowerBound": 1,
  "autoconversion": {
    "targetCurrency": "text",
    "amount": 1
  },
  "fiatAvailable": true
}

New Single Fiat Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Response with invoice data

idstringRequired

Invoice id

invoiceAddressstringRequired

Crypto address for deposit

typestring · enumRequired

The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters

Possible values:

amountnumberOptional

Amount of the invoice

feenumberOptional

Service fee for invoice. This amount will be deducted from invoice amount

totalDebitAmountnumberRequired

The total amount of money received on the invoice wallet

currencystringRequired

Currency of the invoice

statestring · enumRequired

Status of the invoice

Possible values:

lastDepositHashstringOptional

Hash of the last deposit transaction to the invoice

descriptionstringRequired

Short invoice description

createdDatestring · date-timeRequired

Time of invoice creation

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the invoice

expirationstring · date-timeOptional

Server timestamp of invoice expiration moment

fiatAmountnumberOptional

Amount of fiat money set for SINGLE_FIAT_INVOICE

fiatCurrencystringOptional

Currency of featAmount

lastFiatUpdatedstring · date-timeOptional

Time when the exchange rate was updated last time in SINGLE_FIAT invoices

interventionTypestring · enumOptional

Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount

Possible values:

isInterventionResolvedbooleanRequired

Represents whether the intervention was resolved or not (set by user)

subscriptionEnabledbooleanRequired

Represents whether client subscribed on email notifications or not

returnUrlstringOptional

Link to the web page where client can come back to from payment link (page with invoice data for payment)

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px

supportUrlstringOptional

Link to the merchant support page where client can go to from payment link (page with invoice data for payment)

externalIdstringOptional

Merchant ID that can be assigned to invoice or several invoices in string format

lowerBoundnumberOptional

Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored

fiatAvailablebooleanRequired

Fiat available

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/single-fiat/create

HTTPcURLJavaScriptPython

POST /api/v1/invoice/single-fiat/create HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "fiatAmount": 1,
    "fiatCurrency": "text",
    "expiration": "2026-03-05T00:03:46.727Z",
    "currency": "text",
    "description": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "returnUrl": "text",
    "logoUrl": "text",
    "supportUrl": "text",
    "externalId": "text",
    "fiatAvailable": true
  }
}

{
  "id": "text",
  "invoiceAddress": "text",
  "type": "SINGLE",
  "amount": 1,
  "fee": 1,
  "totalDebitAmount": 1,
  "currency": "text",
  "state": "MEM_POOL_FOUND",
  "lastDepositHash": "text",
  "description": "text",
  "createdDate": "2026-03-05T00:03:46.727Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2026-03-05T00:03:46.727Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2026-03-05T00:03:46.727Z",
  "interventionType": "OVERPAY",
  "isInterventionResolved": true,
  "subscriptionEnabled": true,
  "returnUrl": "text",
  "logoUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "lowerBound": 1,
  "autoconversion": {
    "targetCurrency": "text",
    "amount": 1
  },
  "fiatAvailable": true
}

Resolve intervention and receive money to the wallet

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Response with invoice data

idstringRequired

Invoice id

invoiceAddressstringRequired

Crypto address for deposit

typestring · enumRequired

The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters

Possible values:

amountnumberOptional

Amount of the invoice

feenumberOptional

Service fee for invoice. This amount will be deducted from invoice amount

totalDebitAmountnumberRequired

The total amount of money received on the invoice wallet

currencystringRequired

Currency of the invoice

statestring · enumRequired

Status of the invoice

Possible values:

lastDepositHashstringOptional

Hash of the last deposit transaction to the invoice

descriptionstringRequired

Short invoice description

createdDatestring · date-timeRequired

Time of invoice creation

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the invoice

expirationstring · date-timeOptional

Server timestamp of invoice expiration moment

fiatAmountnumberOptional

Amount of fiat money set for SINGLE_FIAT_INVOICE

fiatCurrencystringOptional

Currency of featAmount

lastFiatUpdatedstring · date-timeOptional

Time when the exchange rate was updated last time in SINGLE_FIAT invoices

interventionTypestring · enumOptional

Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount

Possible values:

isInterventionResolvedbooleanRequired

Represents whether the intervention was resolved or not (set by user)

subscriptionEnabledbooleanRequired

Represents whether client subscribed on email notifications or not

returnUrlstringOptional

Link to the web page where client can come back to from payment link (page with invoice data for payment)

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px

supportUrlstringOptional

Link to the merchant support page where client can go to from payment link (page with invoice data for payment)

externalIdstringOptional

Merchant ID that can be assigned to invoice or several invoices in string format

lowerBoundnumberOptional

Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored

fiatAvailablebooleanRequired

Fiat available

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/return-to-paid

HTTPcURLJavaScriptPython

POST /api/v1/invoice/return-to-paid HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "id": "text",
  "invoiceAddress": "text",
  "type": "SINGLE",
  "amount": 1,
  "fee": 1,
  "totalDebitAmount": 1,
  "currency": "text",
  "state": "MEM_POOL_FOUND",
  "lastDepositHash": "text",
  "description": "text",
  "createdDate": "2026-03-05T00:03:46.727Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2026-03-05T00:03:46.727Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2026-03-05T00:03:46.727Z",
  "interventionType": "OVERPAY",
  "isInterventionResolved": true,
  "subscriptionEnabled": true,
  "returnUrl": "text",
  "logoUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "lowerBound": 1,
  "autoconversion": {
    "targetCurrency": "text",
    "amount": 1
  },
  "fiatAvailable": true
}

Get Payment for the Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Response with invoice payment data

idstringRequired

ID of the payment

statestring · enumRequired

State of the payment

Possible values:

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/payment

HTTPcURLJavaScriptPython

POST /api/v1/invoice/payment HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "paymentId": "text",
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "id": "text",
  "state": "IN_PROGRESS"
}

Get all Payments for the Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Object with page details

pageinteger · int32Required

Numeric value indicating the page number

sizeinteger · int32Required

Numeric value indicating the page size

totalinteger · int32Required

Total number of pages matching the query

totalElementsinteger · int64Required

Total number of objects matching the query

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/payment-history

HTTPcURLJavaScriptPython

POST /api/v1/invoice/payment-history HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "pageNumber": 1,
    "pageSize": 10,
    "sort": "ASC",
    "properties": "text"
  }
}

{
  "result": [
    {
      "id": "text",
      "state": "IN_PROGRESS"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}

Get Invoices by External ID

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Object with page details

pageinteger · int32Required

Numeric value indicating the page number

sizeinteger · int32Required

Numeric value indicating the page size

totalinteger · int32Required

Total number of pages matching the query

totalElementsinteger · int64Required

Total number of objects matching the query

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/external

HTTPcURLJavaScriptPython

POST /api/v1/invoice/external HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "externalId": "text",
    "pageNumber": 1,
    "pageSize": 10,
    "sort": "ASC",
    "properties": "text"
  }
}

{
  "result": [
    {
      "id": "text",
      "invoiceAddress": "text",
      "type": "SINGLE",
      "amount": 1,
      "fee": 1,
      "totalDebitAmount": 1,
      "currency": "text",
      "state": "MEM_POOL_FOUND",
      "lastDepositHash": "text",
      "description": "text",
      "createdDate": "2026-03-05T00:03:46.727Z",
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "expiration": "2026-03-05T00:03:46.727Z",
      "fiatAmount": 1,
      "fiatCurrency": "text",
      "lastFiatUpdated": "2026-03-05T00:03:46.727Z",
      "interventionType": "OVERPAY",
      "isInterventionResolved": true,
      "subscriptionEnabled": true,
      "returnUrl": "text",
      "logoUrl": "text",
      "supportUrl": "text",
      "externalId": "text",
      "lowerBound": 1,
      "autoconversion": {
        "targetCurrency": "text",
        "amount": 1
      },
      "fiatAvailable": true
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}

Get Deposit for the Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Response with invoice deposit data

idstring · uuidRequired

ID of the deposit

amountnumberRequired

Amount of the deposit

currencystringRequired

Currency of the deposit

transactionHashstringOptional

Hash of the income transaction

createdDatestring · date-timeRequired

Date of the deposit

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/deposit

HTTPcURLJavaScriptPython

POST /api/v1/invoice/deposit HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "transactionId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 1,
  "currency": "text",
  "transactionHash": "text",
  "createdDate": "2026-03-05T00:03:46.727Z"
}

Get all Deposits for the Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Object with page details

pageinteger · int32Required

Numeric value indicating the page number

sizeinteger · int32Required

Numeric value indicating the page size

totalinteger · int32Required

Total number of pages matching the query

totalElementsinteger · int64Required

Total number of objects matching the query

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/deposit-history

HTTPcURLJavaScriptPython

POST /api/v1/invoice/deposit-history HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "pageNumber": 1,
    "pageSize": 10,
    "sort": "ASC",
    "properties": "text"
  }
}

{
  "result": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 1,
      "currency": "text",
      "transactionHash": "text",
      "createdDate": "2026-03-05T00:03:46.727Z"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}

Mark that intervention is relolved in Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Response with invoice data

idstringRequired

Invoice id

invoiceAddressstringRequired

Crypto address for deposit

typestring · enumRequired

The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters

Possible values:

amountnumberOptional

Amount of the invoice

feenumberOptional

Service fee for invoice. This amount will be deducted from invoice amount

totalDebitAmountnumberRequired

The total amount of money received on the invoice wallet

currencystringRequired

Currency of the invoice

statestring · enumRequired

Status of the invoice

Possible values:

lastDepositHashstringOptional

Hash of the last deposit transaction to the invoice

descriptionstringRequired

Short invoice description

createdDatestring · date-timeRequired

Time of invoice creation

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the invoice

expirationstring · date-timeOptional

Server timestamp of invoice expiration moment

fiatAmountnumberOptional

Amount of fiat money set for SINGLE_FIAT_INVOICE

fiatCurrencystringOptional

Currency of featAmount

lastFiatUpdatedstring · date-timeOptional

Time when the exchange rate was updated last time in SINGLE_FIAT invoices

interventionTypestring · enumOptional

Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount

Possible values:

isInterventionResolvedbooleanRequired

Represents whether the intervention was resolved or not (set by user)

subscriptionEnabledbooleanRequired

Represents whether client subscribed on email notifications or not

returnUrlstringOptional

Link to the web page where client can come back to from payment link (page with invoice data for payment)

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px

supportUrlstringOptional

Link to the merchant support page where client can go to from payment link (page with invoice data for payment)

externalIdstringOptional

Merchant ID that can be assigned to invoice or several invoices in string format

lowerBoundnumberOptional

Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored

fiatAvailablebooleanRequired

Fiat available

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/close-intervention

HTTPcURLJavaScriptPython

POST /api/v1/invoice/close-intervention HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "id": "text",
  "invoiceAddress": "text",
  "type": "SINGLE",
  "amount": 1,
  "fee": 1,
  "totalDebitAmount": 1,
  "currency": "text",
  "state": "MEM_POOL_FOUND",
  "lastDepositHash": "text",
  "description": "text",
  "createdDate": "2026-03-05T00:03:46.727Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2026-03-05T00:03:46.727Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2026-03-05T00:03:46.727Z",
  "interventionType": "OVERPAY",
  "isInterventionResolved": true,
  "subscriptionEnabled": true,
  "returnUrl": "text",
  "logoUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "lowerBound": 1,
  "autoconversion": {
    "targetCurrency": "text",
    "amount": 1
  },
  "fiatAvailable": true
}

New Bound Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Response with invoice data

idstringRequired

Invoice id

invoiceAddressstringRequired

Crypto address for deposit

typestring · enumRequired

The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters

Possible values:

amountnumberOptional

Amount of the invoice

feenumberOptional

Service fee for invoice. This amount will be deducted from invoice amount

totalDebitAmountnumberRequired

The total amount of money received on the invoice wallet

currencystringRequired

Currency of the invoice

statestring · enumRequired

Status of the invoice

Possible values:

lastDepositHashstringOptional

Hash of the last deposit transaction to the invoice

descriptionstringRequired

Short invoice description

createdDatestring · date-timeRequired

Time of invoice creation

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the invoice

expirationstring · date-timeOptional

Server timestamp of invoice expiration moment

fiatAmountnumberOptional

Amount of fiat money set for SINGLE_FIAT_INVOICE

fiatCurrencystringOptional

Currency of featAmount

lastFiatUpdatedstring · date-timeOptional

Time when the exchange rate was updated last time in SINGLE_FIAT invoices

interventionTypestring · enumOptional

Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount

Possible values:

isInterventionResolvedbooleanRequired

Represents whether the intervention was resolved or not (set by user)

subscriptionEnabledbooleanRequired

Represents whether client subscribed on email notifications or not

returnUrlstringOptional

Link to the web page where client can come back to from payment link (page with invoice data for payment)

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px

supportUrlstringOptional

Link to the merchant support page where client can go to from payment link (page with invoice data for payment)

externalIdstringOptional

Merchant ID that can be assigned to invoice or several invoices in string format

lowerBoundnumberOptional

Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored

fiatAvailablebooleanRequired

Fiat available

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/bound/create

HTTPcURLJavaScriptPython

POST /api/v1/invoice/bound/create HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "lowerBound": 1,
    "expiration": "2026-03-05T00:03:46.727Z",
    "currency": "text",
    "description": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "returnUrl": "text",
    "logoUrl": "text",
    "supportUrl": "text",
    "externalId": "text",
    "fiatAvailable": true
  }
}

{
  "id": "text",
  "invoiceAddress": "text",
  "type": "SINGLE",
  "amount": 1,
  "fee": 1,
  "totalDebitAmount": 1,
  "currency": "text",
  "state": "MEM_POOL_FOUND",
  "lastDepositHash": "text",
  "description": "text",
  "createdDate": "2026-03-05T00:03:46.727Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2026-03-05T00:03:46.727Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2026-03-05T00:03:46.727Z",
  "interventionType": "OVERPAY",
  "isInterventionResolved": true,
  "subscriptionEnabled": true,
  "returnUrl": "text",
  "logoUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "lowerBound": 1,
  "autoconversion": {
    "targetCurrency": "text",
    "amount": 1
  },
  "fiatAvailable": true
}

Archive Invoice

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Response with invoice data

idstringRequired

Invoice id

invoiceAddressstringRequired

Crypto address for deposit

typestring · enumRequired

The type of the invoice. SINGLE - allows to receive one payment in crypto-currency. SINGLE_FIAT - allows to receive one payment in crypto-currency but amount to pay is set in fiat currency. UNLIMITED - allows to receive unlimited amount of payments in crypto-currency. BOUND - allows to receive one payment with any money amount upper than settled in parameters

Possible values:

amountnumberOptional

Amount of the invoice

feenumberOptional

Service fee for invoice. This amount will be deducted from invoice amount

totalDebitAmountnumberRequired

The total amount of money received on the invoice wallet

currencystringRequired

Currency of the invoice

statestring · enumRequired

Status of the invoice

Possible values:

lastDepositHashstringOptional

Hash of the last deposit transaction to the invoice

descriptionstringRequired

Short invoice description

createdDatestring · date-timeRequired

Time of invoice creation

idempotencyKeystring · uuidRequired

The external id in the uuid format that can be generated by user while creating the invoice

expirationstring · date-timeOptional

Server timestamp of invoice expiration moment

fiatAmountnumberOptional

Amount of fiat money set for SINGLE_FIAT_INVOICE

fiatCurrencystringOptional

Currency of featAmount

lastFiatUpdatedstring · date-timeOptional

Time when the exchange rate was updated last time in SINGLE_FIAT invoices

interventionTypestring · enumOptional

Represents the case of intervention: UNDERPAY - client paid less money than payAmount, OVERPAY - client paid more money than payAmount

Possible values:

isInterventionResolvedbooleanRequired

Represents whether the intervention was resolved or not (set by user)

subscriptionEnabledbooleanRequired

Represents whether client subscribed on email notifications or not

returnUrlstringOptional

Link to the web page where client can come back to from payment link (page with invoice data for payment)

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment link (page with invoice data for payment). The logo must be in PNG format. Recommended size 100*24 px

supportUrlstringOptional

Link to the merchant support page where client can go to from payment link (page with invoice data for payment)

externalIdstringOptional

Merchant ID that can be assigned to invoice or several invoices in string format

lowerBoundnumberOptional

Minimal amount for invoice deposit in BOUND invoices. Deposits with lower amount will be ignored

fiatAvailablebooleanRequired

Fiat available

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/archive

HTTPcURLJavaScriptPython

POST /api/v1/invoice/archive HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000"
  }
}

{
  "id": "text",
  "invoiceAddress": "text",
  "type": "SINGLE",
  "amount": 1,
  "fee": 1,
  "totalDebitAmount": 1,
  "currency": "text",
  "state": "MEM_POOL_FOUND",
  "lastDepositHash": "text",
  "description": "text",
  "createdDate": "2026-03-05T00:03:46.727Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2026-03-05T00:03:46.727Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2026-03-05T00:03:46.727Z",
  "interventionType": "OVERPAY",
  "isInterventionResolved": true,
  "subscriptionEnabled": true,
  "returnUrl": "text",
  "logoUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "lowerBound": 1,
  "autoconversion": {
    "targetCurrency": "text",
    "amount": 1
  },
  "fiatAvailable": true
}

Get all Invoices

post

Permission annotations:

Header parameters

KeystringRequired

SignstringRequired

Body

application/json

Object with request data

accountstringRequired

Merchant account ID. Request will be sent for this account

timestampinteger · int64Required

Current unix UTC timestamp in milliseconds. Must not be less than 3 minutes in the past and not greater than 3 minutes in the future

Responses

200

OK

*/*

Object with page details

pageinteger · int32Required

Numeric value indicating the page number

sizeinteger · int32Required

Numeric value indicating the page size

totalinteger · int32Required

Total number of pages matching the query

totalElementsinteger · int64Required

Total number of objects matching the query

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/invoice/all

HTTPcURLJavaScriptPython

POST /api/v1/invoice/all HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "stateNames": [
      "MEM_POOL_FOUND"
    ],
    "typeNames": [
      "SINGLE"
    ],
    "pageNumber": 1,
    "pageSize": 10,
    "sort": "ASC",
    "properties": "text"
  }
}

{
  "result": [
    {
      "id": "text",
      "invoiceAddress": "text",
      "type": "SINGLE",
      "amount": 1,
      "fee": 1,
      "totalDebitAmount": 1,
      "currency": "text",
      "state": "MEM_POOL_FOUND",
      "lastDepositHash": "text",
      "description": "text",
      "createdDate": "2026-03-05T00:03:46.727Z",
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "expiration": "2026-03-05T00:03:46.727Z",
      "fiatAmount": 1,
      "fiatCurrency": "text",
      "lastFiatUpdated": "2026-03-05T00:03:46.727Z",
      "interventionType": "OVERPAY",
      "isInterventionResolved": true,
      "subscriptionEnabled": true,
      "returnUrl": "text",
      "logoUrl": "text",
      "supportUrl": "text",
      "externalId": "text",
      "lowerBound": 1,
      "autoconversion": {
        "targetCurrency": "text",
        "amount": 1
      },
      "fiatAvailable": true
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}