Rewrite Migration Guide

Migration guide from MacDue's v2 to PizzaFox's v3.

This page describes key API methods used to initiate transactions within the new API (Since the auto-generated documentation has several errors). You're welcomed to test everything out yourself.

get
Get Transactions

https://discoin.zws.im/transactions/:id
Retrieves transactions. All retrieved transactions will NOT be automatically marked as "Processed". A PATCH request (described later) will do so. API docs are mostly correct for this and are more detailed.
Request
Response
Request
Path Parameters
id
optional
string
Transaction ID.
Query Parameters
filter
optional
string
Filter results of your query. If you don't specify this, the API returns all transactions. If you only want relevant unprocessed transactions, you can putfilter=to.id||eq||ABC&filter=handled||eq||false here (gotta be URL encoded, of course).
Response
200: OK
An array of transactions, or an object of transaction if :id is specified.
[
{
"id": "188986c9-7f50-479b-a447-74ccbb9ab383",
"amount": 10,
"user": "210024244766179329",
"handled": true,
"timestamp": "2019-12-25T07:21:54.941Z",
"payout": 1,
"from": {
"id": "OAT",
"name": "Dice Oats"
},
"to": {
"id": "DTS",
"name": "Discordtel Credits"
}
}
]

post
Create New Transaction

https://discoin.zws.im/transactions
Request a transaction.
Request
Response
Request
Headers
Authorization
required
string
"Bearer " + your token.
Body Parameters
amount
required
number
Transaction amount in original currency.
toId
required
string
String, 3-letter currency code representing the destination currency. It's "toId" not the past form of "told".
user
required
string
ID of user who requested the transaction.
Response
201: Created
Shows transaction details. Notice that it provides the transaction ID as well.
{
"id": "b9cd2775-f354-4b6c-9a8b-5ad24b8cc11d",
"amount": 1000,
"user": "210024244766179329",
"handled": false,
"timestamp": "2019-12-25T18:27:27.773Z",
"payout": 100.1,
"from": {
"id": "DTS",
"name": "Discordtel Credits"
},
"to": {
"id": "OAT",
"name": "Dice Oats"
}
}

patch
Process transactions

https://discoin.zws.im/transactions/:id
Update a transaction, usually this means marking a transaction as processed.
Request
Response
Request
Path Parameters
id
required
string
Transaction ID.
Headers
Authorization
required
string
"Bearer " + your token.
Body Parameters
handled
optional
boolean
Should be true to mark this transaction as processed.
Response
200: OK
Shows updated transaction details.
{
"id": "b9cd2775-f354-4b6c-9a8b-5ad24b8cc11d",
"amount": 1000,
"user": "210024244766179329",
"handled": true,
"timestamp": "2019-12-25T18:27:27.773Z",
"payout": 100.1,
"from": {
"id": "DTS",
"name": "Discordtel Credits"
},
"to": {
"id": "OAT",
"name": "Dice Oats"
}
}