Skip to content

Schuman API (1.0)

API for Schuman's stablecoin platform.

Download OpenAPI description
Overview
Languages
Servers
Mock server

https://docs.api.schuman.io/_mock/openapi/

Operations
Operations

Request

Retrieves all transfer history (deposits, withdrawals, mints, redemptions) for the customer.

Security
api-key
Path
customerIdstring(uuid)required

Customer ID (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000
Query
limitnumber

Maximum number of transfers to return

Example: limit=10
curl -i -X GET \
  'https://docs.api.schuman.io/_mock/openapi/transfer/550e8400-e29b-41d4-a716-446655440000/history?limit=10' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Transfer history retrieved successfully

Bodyapplication/json
listArray of objects
Response
application/json
{ "list": [ {} ] }

Request

Retrieves all bank transfers (SEPA, internal, deposits, withdrawals) for the customer.

Security
api-key
Path
customerIdstring(uuid)required

Customer ID (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000
Query
limitnumber

Maximum number of transfers to return

Example: limit=50
curl -i -X GET \
  'https://docs.api.schuman.io/_mock/openapi/transfer/550e8400-e29b-41d4-a716-446655440000/bank-transfers?limit=50' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Bank transfers retrieved successfully

Bodyapplication/json
listArray of objects
Response
application/json
{ "list": [ {} ] }

Request

Retrieves all crypto transfers (mints and redemptions) for the customer.

Security
api-key
Path
customerIdstring(uuid)required

Customer ID (UUID)

Example: 550e8400-e29b-41d4-a716-446655440000
Query
limitnumber

Maximum number of transfers to return

Example: limit=50
curl -i -X GET \
  'https://docs.api.schuman.io/_mock/openapi/transfer/550e8400-e29b-41d4-a716-446655440000/crypto-transfers?limit=50' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Crypto transfers retrieved successfully

Bodyapplication/json
listArray of objects
Response
application/json
{ "list": [ {} ] }
Operations
Operations