Payment Widget API

API for payment widgets

Get Unlimited Linked Payment widget by 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

*/*

Response with unlimited payment widget data

idempotencyKeystring · uuidRequired

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

cryptoCurrenciesstring[]Required

Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface

descriptionstringRequired

Description of the payment widget

widgetTypestring · enumRequired

Type of the payment widget

Possible values:

widgetStatestring · enumRequired

Status of the the payment widget

Possible values:

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px

returnUrlstringOptional

Link to the web page where client can come back to from payment widget page

supportUrlstringOptional

Link to the merchant support page where client can go to from payment widget page

externalIdstringOptional

Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id

createdDatestring · date-timeRequired

Time of payment widget creation

expirationstring · date-timeOptional

Represents server timestamp of the invoice of the payment widget expiration moment

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/payment-widget/unlimited-linked/find

HTTPcURLJavaScriptPython

POST /api/v1/payment-widget/unlimited-linked/find HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 95

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

{
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "cryptoCurrencies": [
    "text"
  ],
  "description": "text",
  "widgetType": "SINGLE_FIAT",
  "widgetState": "IN_PROGRESS",
  "logoUrl": "text",
  "returnUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "invoices": [
    {
      "invoiceId": "text",
      "cryptoCurrency": "text",
      "invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceExternalId": "text"
    }
  ],
  "createdDate": "2026-02-24T22:40:52.578Z",
  "expiration": "2026-02-24T22:40:52.578Z"
}

Create new Unlimited Linked payment widget

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 unlimited payment widget data

idempotencyKeystring · uuidRequired

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

cryptoCurrenciesstring[]Required

Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface

descriptionstringRequired

Description of the payment widget

widgetTypestring · enumRequired

Type of the payment widget

Possible values:

widgetStatestring · enumRequired

Status of the the payment widget

Possible values:

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px

returnUrlstringOptional

Link to the web page where client can come back to from payment widget page

supportUrlstringOptional

Link to the merchant support page where client can go to from payment widget page

externalIdstringOptional

Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id

createdDatestring · date-timeRequired

Time of payment widget creation

expirationstring · date-timeOptional

Represents server timestamp of the invoice of the payment widget expiration moment

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/payment-widget/unlimited-linked/create

HTTPcURLJavaScriptPython

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "cryptoCurrencies": [
      "text"
    ],
    "description": "text",
    "logoUrl": "text",
    "returnUrl": "text",
    "supportUrl": "text",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "text",
    "expiration": "2026-02-24T22:40:52.578Z"
  }
}

{
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "cryptoCurrencies": [
    "text"
  ],
  "description": "text",
  "widgetType": "SINGLE_FIAT",
  "widgetState": "IN_PROGRESS",
  "logoUrl": "text",
  "returnUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "invoices": [
    {
      "invoiceId": "text",
      "cryptoCurrency": "text",
      "invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceExternalId": "text"
    }
  ],
  "createdDate": "2026-02-24T22:40:52.578Z",
  "expiration": "2026-02-24T22:40:52.578Z"
}

Archive Unlimited Linked Payment widget by 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

*/*

Response with unlimited payment widget data

idempotencyKeystring · uuidRequired

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

cryptoCurrenciesstring[]Required

Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface

descriptionstringRequired

Description of the payment widget

widgetTypestring · enumRequired

Type of the payment widget

Possible values:

widgetStatestring · enumRequired

Status of the the payment widget

Possible values:

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px

returnUrlstringOptional

Link to the web page where client can come back to from payment widget page

supportUrlstringOptional

Link to the merchant support page where client can go to from payment widget page

externalIdstringOptional

Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id

createdDatestring · date-timeRequired

Time of payment widget creation

expirationstring · date-timeOptional

Represents server timestamp of the invoice of the payment widget expiration moment

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/payment-widget/unlimited-linked/archive

HTTPcURLJavaScriptPython

POST /api/v1/payment-widget/unlimited-linked/archive HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 95

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

{
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "cryptoCurrencies": [
    "text"
  ],
  "description": "text",
  "widgetType": "SINGLE_FIAT",
  "widgetState": "IN_PROGRESS",
  "logoUrl": "text",
  "returnUrl": "text",
  "supportUrl": "text",
  "externalId": "text",
  "invoices": [
    {
      "invoiceId": "text",
      "cryptoCurrency": "text",
      "invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceExternalId": "text"
    }
  ],
  "createdDate": "2026-02-24T22:40:52.578Z",
  "expiration": "2026-02-24T22:40:52.578Z"
}

Get all Unlimited Linked Payment widgets

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/payment-widget/unlimited-linked/all

HTTPcURLJavaScriptPython

POST /api/v1/payment-widget/unlimited-linked/all HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "widgetStates": [
      "IN_PROGRESS"
    ],
    "pageNumber": 1,
    "size": 10
  }
}

{
  "result": [
    {
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "cryptoCurrencies": [
        "text"
      ],
      "description": "text",
      "widgetType": "SINGLE_FIAT",
      "widgetState": "IN_PROGRESS",
      "logoUrl": "text",
      "returnUrl": "text",
      "supportUrl": "text",
      "externalId": "text",
      "invoices": [
        {
          "invoiceId": "text",
          "cryptoCurrency": "text",
          "invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
          "invoiceExternalId": "text"
        }
      ],
      "createdDate": "2026-02-24T22:40:52.578Z",
      "expiration": "2026-02-24T22:40:52.578Z"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}

Get Single Fiat Payment widget by 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

*/*

Response with single fiat invoice data

idempotencyKeystring · uuidRequired

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

cryptoCurrenciesstring[]Required

Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface

widgetTypestring · enumRequired

Type of the payment widget

Possible values:

widgetStatestring · enumRequired

Status of the payment widget

Possible values:

fiatCurrencystringRequired

Fiat currency of the widget

fiatAmountnumberRequired

Amount in fiat currency for invoice created from this payment widget

descriptionstringRequired

Description of the payment widget

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px

returnUrlstringOptional

Link to the web page where client can come back to from payment widget page

supportUrlstringOptional

Link to the merchant support page where client can go to from payment widget page

expirationstring · date-timeRequired

Represents server timestamp of payment widget expiration moment

externalIdstringOptional

Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id

createdDatestring · date-timeRequired

Time of payment widget creation

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/payment-widget/single-fiat/find

HTTPcURLJavaScriptPython

POST /api/v1/payment-widget/single-fiat/find HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 95

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

{
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "cryptoCurrencies": [
    "text"
  ],
  "widgetType": "SINGLE_FIAT",
  "widgetState": "IN_PROGRESS",
  "fiatCurrency": "text",
  "fiatAmount": 1,
  "description": "text",
  "logoUrl": "text",
  "returnUrl": "text",
  "supportUrl": "text",
  "expiration": "2026-02-24T22:40:52.578Z",
  "externalId": "text",
  "invoices": [
    {
      "invoiceId": "text",
      "cryptoCurrency": "text",
      "invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceExternalId": "text"
    }
  ],
  "createdDate": "2026-02-24T22:40:52.578Z"
}

Create new Single Fiat Payment widget

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 single fiat invoice data

idempotencyKeystring · uuidRequired

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

cryptoCurrenciesstring[]Required

Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface

widgetTypestring · enumRequired

Type of the payment widget

Possible values:

widgetStatestring · enumRequired

Status of the payment widget

Possible values:

fiatCurrencystringRequired

Fiat currency of the widget

fiatAmountnumberRequired

Amount in fiat currency for invoice created from this payment widget

descriptionstringRequired

Description of the payment widget

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px

returnUrlstringOptional

Link to the web page where client can come back to from payment widget page

supportUrlstringOptional

Link to the merchant support page where client can go to from payment widget page

expirationstring · date-timeRequired

Represents server timestamp of payment widget expiration moment

externalIdstringOptional

Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id

createdDatestring · date-timeRequired

Time of payment widget creation

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/payment-widget/single-fiat/create

HTTPcURLJavaScriptPython

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

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "fiatCurrency": "text",
    "fiatAmount": 1,
    "description": "text",
    "cryptoCurrencies": [
      "text"
    ],
    "logoUrl": "text",
    "returnUrl": "text",
    "supportUrl": "text",
    "expiration": "2026-02-24T22:40:52.578Z",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "externalId": "text"
  }
}

{
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "cryptoCurrencies": [
    "text"
  ],
  "widgetType": "SINGLE_FIAT",
  "widgetState": "IN_PROGRESS",
  "fiatCurrency": "text",
  "fiatAmount": 1,
  "description": "text",
  "logoUrl": "text",
  "returnUrl": "text",
  "supportUrl": "text",
  "expiration": "2026-02-24T22:40:52.578Z",
  "externalId": "text",
  "invoices": [
    {
      "invoiceId": "text",
      "cryptoCurrency": "text",
      "invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceExternalId": "text"
    }
  ],
  "createdDate": "2026-02-24T22:40:52.578Z"
}

Archive Single Fiat Payment widget by 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

*/*

Response with single fiat invoice data

idempotencyKeystring · uuidRequired

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

cryptoCurrenciesstring[]Required

Currency of merchant's wallets where funds will be withdrawn to. The order currencies transmitted to the request will be saved in the interface

widgetTypestring · enumRequired

Type of the payment widget

Possible values:

widgetStatestring · enumRequired

Status of the payment widget

Possible values:

fiatCurrencystringRequired

Fiat currency of the widget

fiatAmountnumberRequired

Amount in fiat currency for invoice created from this payment widget

descriptionstringRequired

Description of the payment widget

logoUrlstringOptional

Link to the logo of merchant which will be shown in the payment widget page. The logo must be in PNG format. Recommended size 100*24 px

returnUrlstringOptional

Link to the web page where client can come back to from payment widget page

supportUrlstringOptional

Link to the merchant support page where client can go to from payment widget page

expirationstring · date-timeRequired

Represents server timestamp of payment widget expiration moment

externalIdstringOptional

Merchant ID that can be assigned to one or several payment widgets in string format. All invoices created in this payment widget will get the same external id

createdDatestring · date-timeRequired

Time of payment widget creation

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/payment-widget/single-fiat/archive

HTTPcURLJavaScriptPython

POST /api/v1/payment-widget/single-fiat/archive HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 95

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

{
  "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
  "cryptoCurrencies": [
    "text"
  ],
  "widgetType": "SINGLE_FIAT",
  "widgetState": "IN_PROGRESS",
  "fiatCurrency": "text",
  "fiatAmount": 1,
  "description": "text",
  "logoUrl": "text",
  "returnUrl": "text",
  "supportUrl": "text",
  "expiration": "2026-02-24T22:40:52.578Z",
  "externalId": "text",
  "invoices": [
    {
      "invoiceId": "text",
      "cryptoCurrency": "text",
      "invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceExternalId": "text"
    }
  ],
  "createdDate": "2026-02-24T22:40:52.578Z"
}

Get all Single Fiat Payment widgets

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/payment-widget/single-fiat/all

HTTPcURLJavaScriptPython

POST /api/v1/payment-widget/single-fiat/all HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "widgetStates": [
      "IN_PROGRESS"
    ],
    "pageNumber": 1,
    "size": 10
  }
}

{
  "result": [
    {
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "cryptoCurrencies": [
        "text"
      ],
      "widgetType": "SINGLE_FIAT",
      "widgetState": "IN_PROGRESS",
      "fiatCurrency": "text",
      "fiatAmount": 1,
      "description": "text",
      "logoUrl": "text",
      "returnUrl": "text",
      "supportUrl": "text",
      "expiration": "2026-02-24T22:40:52.578Z",
      "externalId": "text",
      "invoices": [
        {
          "invoiceId": "text",
          "cryptoCurrency": "text",
          "invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
          "invoiceExternalId": "text"
        }
      ],
      "createdDate": "2026-02-24T22:40:52.578Z"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}