Customer Purse API

API for customer purse

Get Customer Purse Transaction

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

*/*

Transaction data

idstring · uuidRequired

Transaction ID

amountnumberRequired

Amount

addressFromstringRequired

Address from

currencystringRequired

Currency

transactionHashstringOptional

Hash

transactionStatestring · enumRequired

Transaction State

Possible values:

complianceStatestring · enumRequired

Compliance State

Possible values:

translationToAccountCompletedbooleanRequired

Translation to account completed

createdDatestring · date-timeRequired

Date

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/customer-purse/transaction/get

HTTPcURLJavaScriptPython

POST /api/v1/customer-purse/transaction/get HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 99

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 1,
  "addressFrom": "text",
  "currency": "text",
  "transactionHash": "text",
  "transactionState": "MEM_POOL_FOUND",
  "complianceState": "UNCHECKED",
  "translationToAccountCompleted": true,
  "createdDate": "2026-02-28T02:49:49.460Z"
}

Find Customer Purse Transactions

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/customer-purse/transaction/find

HTTPcURLJavaScriptPython

POST /api/v1/customer-purse/transaction/find HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 452

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "currencyFilter": {
      "equals": "text",
      "notEquals": "text",
      "specified": true,
      "in": [
        "text"
      ],
      "notIn": [
        "text"
      ],
      "contains": "text",
      "doesNotContain": "text"
    },
    "transactionStateFilter": {
      "equals": "MEM_POOL_FOUND",
      "notEquals": "MEM_POOL_FOUND",
      "specified": true,
      "in": [
        "MEM_POOL_FOUND"
      ],
      "notIn": [
        "MEM_POOL_FOUND"
      ]
    },
    "pageNumber": 1,
    "pageSize": 10,
    "sort": "ASC",
    "properties": "text"
  }
}

{
  "result": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 1,
      "addressFrom": "text",
      "currency": "text",
      "transactionHash": "text",
      "transactionState": "MEM_POOL_FOUND",
      "complianceState": "UNCHECKED",
      "translationToAccountCompleted": true,
      "createdDate": "2026-02-28T02:49:49.460Z"
    }
  ],
  "page": 1,
  "size": 1,
  "total": 1,
  "totalElements": 1
}

Get Customer Purses

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

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/customer-purse/purse/get-all

HTTPcURLJavaScriptPython

POST /api/v1/customer-purse/purse/get-all HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 96

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

{
  "purses": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "address": "text",
      "currencies": [
        "text"
      ],
      "createdDate": "2026-02-28T02:49:49.460Z"
    }
  ]
}

Update Customer

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

*/*

Customer data

idstring · uuidRequired

ID

emailstringOptional

Email

descriptionstringOptional

Description

externalIdstringOptional

External Id

blockedbooleanRequired

The blocking flag

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/customer-purse/customer/update

HTTPcURLJavaScriptPython

POST /api/v1/customer-purse/customer/update HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 124

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "description": "text",
  "externalId": "text",
  "blocked": true
}

Unblock Customer

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

*/*

Customer data

idstring · uuidRequired

ID

emailstringOptional

Email

descriptionstringOptional

Description

externalIdstringOptional

External Id

blockedbooleanRequired

The blocking flag

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/customer-purse/customer/unblock

HTTPcURLJavaScriptPython

POST /api/v1/customer-purse/customer/unblock HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 96

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "description": "text",
  "externalId": "text",
  "blocked": true
}

Get Customer

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

*/*

Customer data

idstring · uuidRequired

ID

emailstringOptional

Email

descriptionstringOptional

Description

externalIdstringOptional

External Id

blockedbooleanRequired

The blocking flag

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/customer-purse/customer/get

HTTPcURLJavaScriptPython

POST /api/v1/customer-purse/customer/get HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 96

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "description": "text",
  "externalId": "text",
  "blocked": true
}

Get Customers 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

*/*

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/customer-purse/customer/external/get

HTTPcURLJavaScriptPython

POST /api/v1/customer-purse/customer/external/get HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "externalId": "text"
  }
}

{
  "customers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "text",
      "description": "text",
      "externalId": "text",
      "blocked": true
    }
  ]
}

Create new Customer

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

*/*

Customer data

idstring · uuidRequired

ID

emailstringOptional

Email

descriptionstringOptional

Description

externalIdstringOptional

External Id

blockedbooleanRequired

The blocking flag

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/customer-purse/customer/create

HTTPcURLJavaScriptPython

POST /api/v1/customer-purse/customer/create HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "account": "text",
  "timestamp": 1,
  "payload": {
    "email": "text",
    "description": "text",
    "externalId": "text"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "description": "text",
  "externalId": "text",
  "blocked": true
}

Block Customer

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

*/*

Customer data

idstring · uuidRequired

ID

emailstringOptional

Email

descriptionstringOptional

Description

externalIdstringOptional

External Id

blockedbooleanRequired

The blocking flag

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/customer-purse/customer/block

HTTPcURLJavaScriptPython

POST /api/v1/customer-purse/customer/block HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 96

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "description": "text",
  "externalId": "text",
  "blocked": true
}

Get Customer Purse Address

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

*/*

Purse data

idstring · uuidRequired

Purse ID

addressstringRequired

Address

currenciesstring[]Required

Available Currencies

createdDatestring · date-timeRequired

Created Date

400

Bad Request

*/*

500

Internal Server Error

*/*

post

/api/v1/customer-purse/address/get

HTTPcURLJavaScriptPython

POST /api/v1/customer-purse/address/get HTTP/1.1
Host: api.calypso.finance
Key: text
Sign: text
Content-Type: application/json
Accept: */*
Content-Length: 114

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "address": "text",
  "currencies": [
    "text"
  ],
  "createdDate": "2026-02-28T02:49:49.460Z"
}