Invoice API

API for invoices

Get a specific Invoice

post

Permission annotations:

Header parameters
KeystringRequired
SignstringRequired
Body

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
*/*
post
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": "2025-07-05T22:31:09.255Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2025-07-05T22:31:09.255Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2025-07-05T22:31:09.255Z",
  "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

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
*/*
post
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": "2025-07-05T22:31:09.255Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2025-07-05T22:31:09.255Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2025-07-05T22:31:09.255Z",
  "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

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
*/*
post
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": "2025-07-05T22:31:09.255Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2025-07-05T22:31:09.255Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2025-07-05T22:31:09.255Z",
  "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

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
*/*
post
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": "2025-07-05T22:31:09.255Z",
    "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": "2025-07-05T22:31:09.255Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2025-07-05T22:31:09.255Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2025-07-05T22:31:09.255Z",
  "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

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
*/*
post
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": "2025-07-05T22:31:09.255Z",
    "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": "2025-07-05T22:31:09.255Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2025-07-05T22:31:09.255Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2025-07-05T22:31:09.255Z",
  "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

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
*/*
post
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": "2025-07-05T22:31:09.255Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2025-07-05T22:31:09.255Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2025-07-05T22:31:09.255Z",
  "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

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
*/*
post
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

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
*/*
post
POST /api/v1/invoice/payment-history HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "pageNumber": 1,
    "pageSize": 1,
    "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

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
*/*
post
POST /api/v1/invoice/external HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "externalId": "text",
    "pageNumber": 1,
    "pageSize": 1,
    "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": "2025-07-05T22:31:09.255Z",
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "expiration": "2025-07-05T22:31:09.255Z",
      "fiatAmount": 1,
      "fiatCurrency": "text",
      "lastFiatUpdated": "2025-07-05T22:31:09.255Z",
      "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

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
*/*
post
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": "2025-07-05T22:31:09.255Z"
}

Get all Deposits for the Invoice

post

Permission annotations:

Header parameters
KeystringRequired
SignstringRequired
Body

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
*/*
post
POST /api/v1/invoice/deposit-history HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "id": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "pageNumber": 1,
    "pageSize": 1,
    "sort": "ASC",
    "properties": "text"
  }
}
{
  "result": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 1,
      "currency": "text",
      "transactionHash": "text",
      "createdDate": "2025-07-05T22:31:09.255Z"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}

Mark that intervention is relolved in Invoice

post

Permission annotations:

Header parameters
KeystringRequired
SignstringRequired
Body

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
*/*
post
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": "2025-07-05T22:31:09.255Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2025-07-05T22:31:09.255Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2025-07-05T22:31:09.255Z",
  "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

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
*/*
post
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": "2025-07-05T22:31:09.255Z",
    "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": "2025-07-05T22:31:09.255Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2025-07-05T22:31:09.255Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2025-07-05T22:31:09.255Z",
  "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

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
*/*
post
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": "2025-07-05T22:31:09.255Z",
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "expiration": "2025-07-05T22:31:09.255Z",
  "fiatAmount": 1,
  "fiatCurrency": "text",
  "lastFiatUpdated": "2025-07-05T22:31:09.255Z",
  "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

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
*/*
post
POST /api/v1/invoice/all HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "stateNames": [
      "MEM_POOL_FOUND"
    ],
    "typeNames": [
      "SINGLE"
    ],
    "pageNumber": 1,
    "pageSize": 1,
    "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": "2025-07-05T22:31:09.255Z",
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "expiration": "2025-07-05T22:31:09.255Z",
      "fiatAmount": 1,
      "fiatCurrency": "text",
      "lastFiatUpdated": "2025-07-05T22:31:09.255Z",
      "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
}
PreviousCurrency APINextSettlement Report API