Payment Widget API
API for payment widgets
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
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
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": [
{
"name": "text",
"feeCurrencyName": "text",
"coinId": "text",
"networkData": {
"frontName": "text",
"type": "text"
},
"scale": 1,
"blockchainScale": 1,
"garbageAmount": 1,
"crypto": true,
"blockchainName": "text",
"contract": "text",
"enabled": true,
"active": true
}
],
"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": "2025-07-05T17:05:34.275Z",
"expiration": "2025-07-05T17:05:34.275Z"
}
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
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
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: 497
{
"account": "text",
"timestamp": 1,
"payload": {
"cryptoCurrencies": [
{
"name": "text",
"feeCurrencyName": "text",
"coinId": "text",
"networkData": {
"frontName": "text",
"type": "text"
},
"scale": 1,
"blockchainScale": 1,
"garbageAmount": 1,
"crypto": true,
"blockchainName": "text",
"contract": "text",
"enabled": true,
"active": true
}
],
"description": "text",
"logoUrl": "text",
"returnUrl": "text",
"supportUrl": "text",
"idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "text",
"expiration": "2025-07-05T17:05:34.275Z"
}
}
{
"idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
"cryptoCurrencies": [
{
"name": "text",
"feeCurrencyName": "text",
"coinId": "text",
"networkData": {
"frontName": "text",
"type": "text"
},
"scale": 1,
"blockchainScale": 1,
"garbageAmount": 1,
"crypto": true,
"blockchainName": "text",
"contract": "text",
"enabled": true,
"active": true
}
],
"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": "2025-07-05T17:05:34.275Z",
"expiration": "2025-07-05T17:05:34.275Z"
}
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
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
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": [
{
"name": "text",
"feeCurrencyName": "text",
"coinId": "text",
"networkData": {
"frontName": "text",
"type": "text"
},
"scale": 1,
"blockchainScale": 1,
"garbageAmount": 1,
"crypto": true,
"blockchainName": "text",
"contract": "text",
"enabled": true,
"active": true
}
],
"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": "2025-07-05T17:05:34.275Z",
"expiration": "2025-07-05T17:05:34.275Z"
}
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
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
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": [
{
"name": "text",
"feeCurrencyName": "text",
"coinId": "text",
"networkData": {
"frontName": "text",
"type": "text"
},
"scale": 1,
"blockchainScale": 1,
"garbageAmount": 1,
"crypto": true,
"blockchainName": "text",
"contract": "text",
"enabled": true,
"active": true
}
],
"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": "2025-07-05T17:05:34.275Z",
"expiration": "2025-07-05T17:05:34.275Z"
}
],
"page": 1,
"size": 1,
"total": 1,
"totalElements": 1
}
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
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
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": [
{
"name": "text",
"feeCurrencyName": "text",
"coinId": "text",
"networkData": {
"frontName": "text",
"type": "text"
},
"scale": 1,
"blockchainScale": 1,
"garbageAmount": 1,
"crypto": true,
"blockchainName": "text",
"contract": "text",
"enabled": true,
"active": true
}
],
"widgetType": "SINGLE_FIAT",
"widgetState": "IN_PROGRESS",
"fiatCurrency": "text",
"fiatAmount": 1,
"description": "text",
"logoUrl": "text",
"returnUrl": "text",
"supportUrl": "text",
"expiration": "2025-07-05T17:05:34.275Z",
"externalId": "text",
"invoices": [
{
"invoiceId": "text",
"cryptoCurrency": "text",
"invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
"invoiceExternalId": "text"
}
],
"createdDate": "2025-07-05T17:05:34.275Z"
}
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
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
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: 534
{
"account": "text",
"timestamp": 1,
"payload": {
"fiatCurrency": "text",
"fiatAmount": 1,
"description": "text",
"cryptoCurrencies": [
{
"name": "text",
"feeCurrencyName": "text",
"coinId": "text",
"networkData": {
"frontName": "text",
"type": "text"
},
"scale": 1,
"blockchainScale": 1,
"garbageAmount": 1,
"crypto": true,
"blockchainName": "text",
"contract": "text",
"enabled": true,
"active": true
}
],
"logoUrl": "text",
"returnUrl": "text",
"supportUrl": "text",
"expiration": "2025-07-05T17:05:34.275Z",
"idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
"externalId": "text"
}
}
{
"idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
"cryptoCurrencies": [
{
"name": "text",
"feeCurrencyName": "text",
"coinId": "text",
"networkData": {
"frontName": "text",
"type": "text"
},
"scale": 1,
"blockchainScale": 1,
"garbageAmount": 1,
"crypto": true,
"blockchainName": "text",
"contract": "text",
"enabled": true,
"active": true
}
],
"widgetType": "SINGLE_FIAT",
"widgetState": "IN_PROGRESS",
"fiatCurrency": "text",
"fiatAmount": 1,
"description": "text",
"logoUrl": "text",
"returnUrl": "text",
"supportUrl": "text",
"expiration": "2025-07-05T17:05:34.275Z",
"externalId": "text",
"invoices": [
{
"invoiceId": "text",
"cryptoCurrency": "text",
"invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
"invoiceExternalId": "text"
}
],
"createdDate": "2025-07-05T17:05:34.275Z"
}
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
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
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": [
{
"name": "text",
"feeCurrencyName": "text",
"coinId": "text",
"networkData": {
"frontName": "text",
"type": "text"
},
"scale": 1,
"blockchainScale": 1,
"garbageAmount": 1,
"crypto": true,
"blockchainName": "text",
"contract": "text",
"enabled": true,
"active": true
}
],
"widgetType": "SINGLE_FIAT",
"widgetState": "IN_PROGRESS",
"fiatCurrency": "text",
"fiatAmount": 1,
"description": "text",
"logoUrl": "text",
"returnUrl": "text",
"supportUrl": "text",
"expiration": "2025-07-05T17:05:34.275Z",
"externalId": "text",
"invoices": [
{
"invoiceId": "text",
"cryptoCurrency": "text",
"invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
"invoiceExternalId": "text"
}
],
"createdDate": "2025-07-05T17:05:34.275Z"
}
Permission annotations:
Object with request data
Merchant account ID. Request will be sent for this account
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
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": [
{
"name": "text",
"feeCurrencyName": "text",
"coinId": "text",
"networkData": {
"frontName": "text",
"type": "text"
},
"scale": 1,
"blockchainScale": 1,
"garbageAmount": 1,
"crypto": true,
"blockchainName": "text",
"contract": "text",
"enabled": true,
"active": true
}
],
"widgetType": "SINGLE_FIAT",
"widgetState": "IN_PROGRESS",
"fiatCurrency": "text",
"fiatAmount": 1,
"description": "text",
"logoUrl": "text",
"returnUrl": "text",
"supportUrl": "text",
"expiration": "2025-07-05T17:05:34.275Z",
"externalId": "text",
"invoices": [
{
"invoiceId": "text",
"cryptoCurrency": "text",
"invoiceIdempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
"invoiceExternalId": "text"
}
],
"createdDate": "2025-07-05T17:05:34.275Z"
}
],
"page": 1,
"size": 1,
"total": 1,
"totalElements": 1
}