Back to explore

finance

Wallet

Credits: 0.000001

Balance

POST /v1/wallet/Balance

Get the balance of a wallet

Request

idstring

wallet id

Response

balancenumber

current balance

Request

Response

{
    "balance": "0"
}

Credits: 0.000001

Create

POST /v1/wallet/Create

Create a new wallet

Request

descriptionstring

description for wallet

idstring

optional id

namestring

name of the wallet

Response

accountobject

the wallet created

Request

Response

{
    "account": {
        "id": "b6407edd-2e26-45c0-9e2c-343689bbe5f6",
        "name": "Greatness",
        "description": "No description needed",
        "balance": "0"
    }
}

Credits: 0.000001

Credit

POST /v1/wallet/Credit

Add credit to a wallet

Request

amountnumber

amount to credit

idstring

wallet id

idempotency_keystring

idempotency key

referencestring

reference note

visibleboolean

if the transaction is visible

Response

balancenumber

the new balance

Request

Response

{
    "balance": "10"
}

Credits: 0.000001

Debit

POST /v1/wallet/Debit

Debit a wallet

Request

amountnumber

amount to debit

idstring

wallet

idempotency_keystring

idempotency key

referencestring

reference note

visibleboolean

if the transaction is visible

Response

balancenumber

the new balance

Request

Response

{
    "balance": "5"
}

Credits: 0.000001

Delete

POST /v1/wallet/Delete

Delete a wallet

Request

idstring

Response

{}

Request

Response

{}

Credits: 0.000001

List

POST /v1/wallet/List

List your wallets

Request

{}

Response

accountsarray

Request

Response

{
    "accounts": [
        {
            "id": "b6407edd-2e26-45c0-9e2c-343689bbe5f6",
            "name": "Greatness",
            "description": "No description needed",
            "balance": "5"
        }
    ]
}

Credits: 0.000001

Read

POST /v1/wallet/Read

Get wallet by id

Request

idstring

wallet id

Response

accountobject

Request

Response

{
    "account": {
        "id": "b6407edd-2e26-45c0-9e2c-343689bbe5f6",
        "name": "Greatness",
        "description": "No description needed",
        "balance": "0"
    }
}

Credits: 0.000001

Transactions

POST /v1/wallet/Transactions

List the transactions for a wallet

Request

idstring

wallet id

Response

transactionsarray

list of transactions

Request

Response

{
    "transactions": [
        {
            "id": "a5455d1a-c090-4cf1-a6a1-8ef8fb38b462",
            "created": "2022-07-25T21:54:13.380533678+01:00",
            "amount": "10",
            "reference": "test credit",
            "metadata": {}
        },
        {
            "id": "a5455d1a-c090-4cf1-a6a1-8ef8fb38b462",
            "created": "2022-07-25T21:54:10.380533678+01:00",
            "amount": "5",
            "reference": "test debit",
            "metadata": {}
        },
        {
            "id": "a4b82d66-aafa-480f-8f5c-b68564ccea6f",
            "created": "2022-07-26T08:38:55.022032883+01:00",
            "amount": "-5",
            "reference": "transfer",
            "metadata": {}
        }
    ]
}

Credits: 0.000001

Transfer

POST /v1/wallet/Transfer

Make a transfer from one wallet to another

Request

amountnumber

amount to transfer

from_idstring

from wallet id

referencestring

reference

to_idstring

to wallet id

visibleboolean

visible?

Response

{}

Request

Response

{}