API-Documentation

General Information

With the API you can make use of many functions of UCash 24. Administrative and most tools functions are not ported.

This documentation is only available in English and has a technical purpose. A regular end-user is not the targeting audience.

To use the API you must first create an API key here. And then provide your wallet id and API key in every request.

The Address for all api functions is https://ucash24.net/api/methodname.

All responses have a status code and a status message. When here is mentioned "No response Data" this means no payload data.

Payment / Requests

The base functions can be accessed via /api/ path.

requestcoins

Logs the given user in when password is correct. A session will be created and filled with user data.

  • Method: POST
  • Parameters:
    • wallet
      Your wallet id
    • apikey
      One of your valid api keys
    • debitor
      Wallet id you request coins from
    • comment
      Description of the request. Use this to check it's status
    • amount
      Amount of coins you request
  • Response:
    • No response data

Example request (curl):

curl --location 'https://app.ucash24.net/api/requestcoins' \
--form 'wallet="00"' \
--form 'apikey="MYSECRETAPIKEY"' \
--form 'debitor="001"' \
--form 'amount="100"' \
--form 'comment="Test transfer"'

Example answer:

{
 "status": {
  "code": 200,
  "message": "Success"
 },
 "data": [
 ]
}


listrequests

Lists all requests

  • Method: POST
  • Parameters:
    • wallet
      Your wallet id
    • apikey
      One of your valid api keys
    • direction
      A single character describing requests to list:
      • r: You are the receiver
      • s: You are the sender
  • Response:
    • Array with requests:
      • rid: ID of the request
      • requestor: Wallet id that requested coins
      • debitor: Wallet id that has to send the money
      • comment: Comment the requestor set
      • createdat: Creation date of the request
      • value: Amount of coins requested
      • whopays: Who has to pay the commission. (s) sender or (r)eceiver

Example request (curl):

curl --location 'https://app.ucash24.net/api/listrequests' \
--form 'wallet="00"' \
--form 'apikey="MYSECRETAPIKEY"' \
--form 'direction="r"'

Example answer:

{
 "status": {
  "code": 200,
  "message": "Success"
 },
 "data": [
  {
   "rid": 1,
   "requestor": "00000000000000000000",
   "debitor": "00000006515651461201",
   "comment": "Franz jagt im komplett verwahrlosten Taxi quer durch Bayern",
   "createdat": "2024-10-19 16:20:16",
   "value": 100,
   "whopays": "s"
  },
  {
   "rid": 2,
   "requestor": "00000000000000000000",
   "debitor": "00000003847621655484",
   "comment": "Testrequest",
   "createdat": "2024-10-19 16:20:27",
   "value": 50,
   "whopays": ""
  }
 ]
}


transfercoins

Performs a transaction

  • Method: POST
  • Parameters:
    • wallet
      Your wallet id
    • apikey
      One of your valid api keys
    • amount
      Amount of coins to transfer
    • whopays
      Who has to pay the transaction?
      • r: You are the receiver
      • s: You are the sender
      • b: Share the commission 50/50
    • rcpt
      Receipient of the transaction
    • comment
      Comment or subject of the transaction
  • Response:
    • No response data

Example request (curl):

curl --location 'https://app.ucash24.net/api/listtranscount' \
--form 'wallet="00"' \
--form 'apikey="MYSECRETAPIKEY"' \
--form 'amount="100"' \
--form 'whopays="b"' \
--form 'rcpt="000ABC"' \
--form 'comment="Test transfer"'

Example answer:

{
 "status": {
  "code": 200,
  "message": "Success"
 },
 "data": [
 ]
}


listtransdate

Lists your transactions in the given month

  • Method: POST
  • Parameters:
    • wallet
      Your wallet id
    • apikey
      One of your valid api keys
    • month
      Month you want the transactions from
    • year
      Year you want the transactions from
  • Response:
    • Array with transactions:
      • tid: Transaction id
      • swid: Sending wallet id
      • rwid: Receiving wallet id
      • value: Amount of coins transferred
      • content: Comment / Subject of the transfer
      • createdat: booking date

Example request (curl):

curl --location 'https://app.ucash24.net/api/listtranscount' \
--form 'wallet="00"' \
--form 'apikey="MYSECRETAPIKEY"' \
--form 'month="11"' \
--form 'year="2024"'

Example answer:

{
 "status": {
  "code": 200,
  "message": "Success"
 },
 "data": [
  {
   "tid": 15,
   "swid": "00000000000000000000",
   "rwid": "0000000000000000000",
   "value": 2,
   "content": "Commission from Discharge of 00000000000000000000",
   "createdat": "2024-11-05 16:34:49"
  },
  {
   "tid": 16,
   "swid": "00000000000000000000",
   "rwid": "00000005812376728727",
   "value": 500,
   "content": "geschenk",
   "createdat": "2024-11-06 14:53:23"
  }
 ]
}

listtranscount

Lists your last x transactions

  • Method:POST
  • Parameters:
    • wallet
      Your wallet id
    • apikey
      One of your valid api keys
    • count
      How many transactions should be fetched
  • Response:
    • Array with transactions:
      • tid: Transaction id
      • swid: Sending wallet id
      • rwid: Receiving wallet id
      • value: Amount of coins transferred
      • content: Comment / Subject of the transfer
      • createdat: booking date

Example request (curl):

curl --location 'https://app.ucash24.net/api/listtranscount' \
--form 'wallet="0123456ABCD"' \
--form 'apikey="MYSECRETAPIKEY"'\

--form 'count="2"'

Example answer:

{
 "status": {
  "code": 200,
  "message": "Success"
 },
 "data": [
  {
   "tid": 15,
   "swid": "00000000000000000000",
   "rwid": "0000000000000000000",
   "value": 2,
   "content": "Commission from Discharge of 00000000000000000000",
   "createdat": "2024-11-05 16:34:49"
  },
  {
   "tid": 16,
   "swid": "00000000000000000000",
   "rwid": "00000004917624260567",
   "value": 500,
   "content": "geschenk",
   "createdat": "2024-11-06 14:53:23"
  }
 ]
}


Password Vault

In the password vault you can store your passwords and retrieve it to use it directly in your scripts or browser plugins

listvault

Lists all stored entries

  • Method: POST
  • Parameters:
    • wallet
      Your wallet id
    • apikey
      One of your valid api keys
  • Response:
    • Array with password entries:
      • pwid: Id of the password entriy. Use this to access the password
      • title: Title of the entry
      • address: Stored address. E.g. https://ucash24.net
      • dateadded: Date and time when this entry was added to the vault
      • dateupdated: Last update date of the entry

Example request (curl):

curl --location 'https://app.ucash24.net/api/listvault' \
--form 'wallet="0123456ABCD"' \
--form 'apikey="MYSECRETAPIKEY"'

Example answer:

{
 "status": {
  "code": 200,
  "message": "Success"
 },
 "data": [
  {
   "pwid": 1,
   "title":
   "Testeintrag",
   "address": "https://ucash24.net",
   "dateadded": "2025-05-26 07:54:10",
   "dateupdated": "2025-05-26 07:54:10"
  }
 ]
}


getvaultpassword

Fetches a password, address and username from a vault entry

  • Method: POST
  • Parameters:
    • wallet
      Your wallet id
    • apikey
      One of your valid api keys
    • pwid
      Id of the vault entry
  • Response:
    • Array with password entry:
      • address: Stored address. E.g. https://ucash24.net
      • user: Username pf the entry
      • password: Saved password

Example request (curl):

curl --location 'https://app.ucash24.net/api/getvaultpassword' \
--form 'wallet="0123456ABCD"' \
--form 'apikey="MYSECRETAPIKEY"' \
--form 'pwid="1"'

Example answer:

{
 "status": {
  "code": 200,
  "message": "Success"
 },
 "data": {
  "address": "https://ucash24.net",
  "user": "0001",
  "password": "foo"
 }
}