Wallet
Module endpoints
GET /wallets
GET /wallets
GET
https://api.slyk.io/wallets
Retrieves a paginated list of wallets
.
The name
filter performs a SQL
query using the like
operator.
{
"data": [
{
"createdAt": "2019-03-20T14:30:37.483Z",
"customData": {},
"description": null,
"id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c7",
"locked": false,
"metadata": {},
"name": "Waldo Fred wallet",
"ownerId": "5a9cf5ad-3999-497a-927e-da7157dc43a6",
"reference": "123456789A",
"updatedAt": "2019-03-20T14:30:37.483Z"
},
{
"createdAt": "2019-03-20T15:30:37.483Z",
"customData": {},
"description": null,
"id": "d9227cef-82b3-4753-b576-46735971774d",
"locked": false,
"metadata": {},
"name": "Corge Garply wallet",
"ownerId": "0bf8ee88-aed1-442c-a191-ffcee735b38a",
"reference": "123456789B",
"updatedAt": "2019-03-20T15:30:37.483Z"
}
],
"total": 2
}
GET /wallets/:id
GET /wallets/:id
GET
https://api.slyk.io/wallets/:id
Gets the wallet details of the given id
.
{
"data": {
"createdAt": "2019-03-20T14:30:37.483Z",
"customData": {},
"description": null,
"id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c7",
"locked": false,
"metadata": {},
"name": "Waldo Fred wallet",
"ownerId": "5a9cf5ad-3999-497a-927e-da7157dc43a6",
"reference": "123456789A",
"updatedAt": "2019-03-20T14:30:37.483Z"
}
}
GET /wallets/:id/activity
GET /wallets/:id/activity
GET
https://api.slyk.io/wallets/:id/activity
Returns the wallet
activity of the given id
.
{
"data": [
{
"amount": "5.00000000",
"assetCode": "foo",
"code": "issue",
"createdAt": "2019-02-04T19:06:40.712Z",
"customData": { "foo": "bar" },
"destinationAddress": null,
"destinationWallet": {
"createdAt": "2019-03-20T14:30:37.483Z",
"customData": {},
"id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c7",
"locked": false,
"metadata": {},
"name": "Waldo Fred wallet",
"ownerId": "dcdbf851-f4db-468b-9235-37ef6e6306a1",
"reference": "123456789A",
"updatedAt": "2019-03-20T14:30:37.483Z"
},
"destinationWalletId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c7",
"destinationWalletUser": {
"approved": true,
"blocked": false,
"createdAt": "2019-07-17T11:39:26.732Z",
"customData": {},
"email": "foo@bar.com",
"id": "dcdbf851-f4db-468b-9235-37ef6e6306a1",
"locale": "en",
"name": "Waldo Fred"
"phone": "+351912345678",
"primaryWalletId": "5a9cf5ad-3999-497a-927e-da7157dc43a6",
"referralCode": "R12345678",
"roles": ["user"],
"updatedAt": "2019-07-17T11:39:26.732Z",
"verified": true
},
"externalId": null,
"id": "06788310-8de1-4afe-b0b4-1293b1ed10c1",
"metadata": { "foo": "biz" },
"originAddress": null,
"originWalletId": null,
"status": "pending",
"type": "deposit",
"updatedAt": "2019-02-04T19:06:40.712Z"
},
{
"amount": "6.00000000",
"assetCode": "garply",
"code": "burn",
"createdAt": "2019-02-04T19:06:40.712Z",
"customData": { "foo": "bar" },
"destinationWalletId": null,
"externalId": null,
"id": "06788310-8de1-4afe-b0b4-1293b1ed10c1",
"metadata": { "foo": "biz" },
"originWallet": {
"createdAt": "2019-03-20T15:30:37.483Z",
"customData": {},
"id": "d9227cef-82b3-4753-b576-46735971774d",
"locked": false,
"metadata": {},
"name": "Corge Garply wallet",
"ownerId": "dcdbf851-f4db-468b-9235-37ef6e6306a1",
"reference": "123456789B",
"updatedAt": "2019-03-20T15:30:37.483Z"
},
"originWalletId": "d9227cef-82b3-4753-b576-46735971774d",
"originWalletUser": {
"approved": true,
"blocked": false,
"createdAt": "2019-07-17T11:39:26.732Z",
"customData": {},
"email": "foo@bar.com",
"id": "dcdbf851-f4db-468b-9235-37ef6e6306a1",
"locale": "en",
"name": "Corge Garply"
"phone": "+351912345678",
"primaryWalletId": "d9227cef-82b3-4753-b576-46735971774d",
"referralCode": "R87654321",
"roles": ["user"],
"updatedAt": "2019-07-17T11:39:26.732Z",
"verified": true
},
"status": "pending",
"type": "withdrawal",
"updatedAt": "2019-02-04T19:06:40.712Z"
}
],
"total": 4
}
GET /wallets/:id/balance
GET /wallets/:id/balance
GET
https://api.slyk.io/wallets/:id/balance
Retrieves a wallet's balance for the various assets it contains. Only assets that were ever transacted on the wallet will be shown (even if their balance is currently zero).
{
"data": [
{ "assetCode": "bar", "amount": "10.00000000" },
{ "assetCode": "biz", "amount": "3.50000000"}
]
}
GET /wallets/:id/movements
GET /wallets/:id/movements
GET
https://api.slyk.io/wallets/:id/movements
Convenience endpoint to get a paginated list of movements
from the wallet of the given id
.
{
"data": [
{
"amount": "4.50000000",
"assetCode": "garply",
"code": "deposit",
"createdAt": "2019-03-20T14:30:37.483Z",
"id": "4617b329-eca0-487d-9086-9bbf833b6c86",
"transaction": {
"amount": "4.50000000",
"assetCode": "garply",
"code": "deposit",
"createdAt": "2019-03-20T14:30:37.483Z",
"customData": { "foo": "bar" },
"description": "foobar",
"destinationAddress": null,
"destinationWalletId": "d4f146bf-4c01-4efc-bc3e-2f9663dc7256",
"externalId": null,
"id": "307d1665-23ba-4ff1-9f0a-1a5f480e5a10",
"metadata": {},
"originAddress": null,
"originWalletId": null,
"status": "confirmed",
"type": "deposit",
"updatedAt": "2019-03-20T14:30:37.483Z"
},
"transactionId": "307d1665-23ba-4ff1-9f0a-1a5f480e5a10",
"updatedAt": "2019-03-20T14:30:37.483Z",
"walletId": "d4f146bf-4c01-4efc-bc3e-2f9663dc7256"
},
{
"amount": "6.00000000",
"assetCode": "garply",
"code": "deposit",
"createdAt": "2017-10-18T11:39:26.732Z",
"id": "5c4a04cc-4e48-4829-bd81-692bb0f0ac08",
"transaction": {
"amount": "6.00000000",
"assetCode": "garply",
"code": "deposit",
"createdAt": "2017-10-18T11:39:26.732Z",
"customData": { "foo": "bar" },
"description": "foobiz",
"destinationAddress": null,
"destinationWalletId": "c7b0fddf-48a9-4867-b712-c71559cf81ac",
"externalId": null,
"id": "e3fd199c-b137-4cb3-9644-533345239772",
"metadata": {},
"originAddress": null,
"originWalletId": null,
"status": "confirmed",
"type": "deposit",
"updatedAt": "2017-10-18T11:39:26.732Z"
},
"transactionId": "e3fd199c-b137-4cb3-9644-533345239772",
"updatedAt": "2017-10-18T11:39:26.732Z",
"walletId": "c7b0fddf-48a9-4867-b712-c71559cf81ac"
}
],
"total": 4
}
GET /wallets/:id/transactions
GET /wallets/:id/transactions
GET
https://api.slyk.io/wallets/:id/transactions
Convenience endepoint endpoint to get a paginated list of transactions
where the wallet id
may be either the destinationWalletId
or the originWalletId
of the Transaction object.
{
"data": [
{
"amount": "5.00000000",
"assetCode": "foo",
"code": "issue",
"createdAt": "2019-02-04T19:06:40.712Z",
"customData": { "foo": "bar" },
"destinationAddress": null,
"destinationWalletId": "9afa8a2d-023a-4040-b591-c03077f43d23",
"externalId": null,
"id": "06788310-8de1-4afe-b0b4-1293b1ed10c1",
"metadata": { "foo": "biz" },
"originAddress": null,
"originWalletId": null,
"status": "pending",
"type": "deposit",
"updatedAt": "2019-02-04T19:06:40.712Z"
},
{
"amount": "6.00000000",
"assetCode": "garply",
"code": "burn",
"createdAt": "2019-02-04T19:06:40.712Z",
"customData": { "foo": "bar" },
"destinationWalletId": null,
"externalId": null,
"id": "06788310-8de1-4afe-b0b4-1293b1ed10c1",
"metadata": { "foo": "biz" },
"originWalletId": "9afa8a2d-023a-4040-b591-c03077f43d23",
"status": "pending",
"type": "withdrawal",
"updatedAt": "2019-02-04T19:06:40.712Z"
}
],
"total": 4
}
GET /wallets/activity
GET /wallets/activity
GET
https://api.slyk.io/wallets/activity
Returns the wallets
activity.
{
"data": [
{
"amount": "5.00000000",
"assetCode": "foo",
"code": "issue",
"createdAt": "2019-02-04T19:06:40.712Z",
"customData": { "foo": "bar" },
"destinationAddress": null,
"destinationWallet": {
"createdAt": "2019-03-20T14:30:37.483Z",
"customData": {},
"id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c7",
"locked": false,
"metadata": {},
"name": "Waldo Fred wallet",
"ownerId": "dcdbf851-f4db-468b-9235-37ef6e6306a1",
"reference": "123456789A",
"updatedAt": "2019-03-20T14:30:37.483Z"
},
"destinationWalletId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c7",
"destinationWalletUser": {
"approved": true,
"blocked": false,
"createdAt": "2019-07-17T11:39:26.732Z",
"customData": {},
"email": "foo@bar.com",
"id": "dcdbf851-f4db-468b-9235-37ef6e6306a1",
"locale": "en",
"name": "Waldo Fred"
"phone": "+351912345678",
"primaryWalletId": "fc78d28f-a8dd-49de-a22f-722fe3bd26c7",
"referralCode": "R12345678",
"roles": ["user"],
"updatedAt": "2019-07-17T11:39:26.732Z",
"verified": true
},
"externalId": null,
"id": "06788310-8de1-4afe-b0b4-1293b1ed10c1",
"metadata": { "foo": "biz" },
"originAddress": null,
"originWalletId": null,
"status": "pending",
"type": "deposit",
"updatedAt": "2019-02-04T19:06:40.712Z"
},
{
"amount": "6.00000000",
"assetCode": "garply",
"code": "burn",
"createdAt": "2019-02-04T19:06:40.712Z",
"customData": { "foo": "bar" },
"destinationWalletId": null,
"externalId": null,
"id": "06788310-8de1-4afe-b0b4-1293b1ed10c1",
"metadata": { "foo": "biz" },
"originWallet": {
"createdAt": "2019-03-20T15:30:37.483Z",
"customData": {},
"id": "d9227cef-82b3-4753-b576-46735971774d",
"locked": false,
"metadata": {},
"name": "Corge Garply wallet",
"ownerId": "dcdbf851-f4db-468b-9235-37ef6e6306a1",
"reference": "123456789B",
"updatedAt": "2019-03-20T15:30:37.483Z"
},
"originWalletId": "d9227cef-82b3-4753-b576-46735971774d",
"originWalletUser": {
"approved": true,
"blocked": false,
"createdAt": "2019-07-17T11:39:26.732Z",
"customData": {},
"email": "foo@bar.com",
"id": "dcdbf851-f4db-468b-9235-37ef6e6306a1",
"locale": "en",
"name": "Corge Garply"
"phone": "+351912345678",
"primaryWalletId": "d9227cef-82b3-4753-b576-46735971774d",
"referralCode": "R87654321",
"roles": ["user"],
"updatedAt": "2019-07-17T11:39:26.732Z",
"verified": true
},
"status": "pending",
"type": "withdrawal",
"updatedAt": "2019-02-04T19:06:40.712Z"
}
],
"total": 4
}
GET /wallets/balance
GET /wallets/balance
GET
https://api.slyk.io/wallets/balance
Retrieves a Slyk balance for the various assets it contains. Only assets that were ever transacted on the wallet will be shown (even if their balance is currently zero).
{
"data": [
{ "assetCode": "bar", "amount": "10.00000000" },
{ "assetCode": "biz", "amount": "3.50000000"}
]
}
PATCH /wallets/:id
PATCH /wallets/:id
PATCH
https://api.slyk.io/wallets/:id
Patch the wallet
details of the given id
.
{
"customData": {
"description": "Someone's first wallet"
}
}
{
"data": {
"createdAt": "2019-03-20T14:30:37.483Z",
"customData": { "qux": "quux" },
"locked": false,
"id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c7",
"metadata": {},
"name": "Foobar wallet",
"reference": "123456789A",
"updatedAt": "2019-03-20T14:30:37.483Z"
}
}
POST /wallets
POST /wallets
POST
https://api.slyk.io/wallets
Creates a new wallet
.
{
"name": "Savings",
"ownerId": "0bf8ee88-aed1-442c-a191-ffcee735b38a"
}
200 Success
{
"data": {
"createdAt": "2019-03-20T14:30:37.483Z",
"customData": { "qux": "quux" },
"locked": false,
"id": "fc78d28f-a8dd-49de-a22f-722fe3bd26c7",
"metadata": {},
"name": "Foobar wallet",
"reference": "123456789A",
"updatedAt": "2019-03-20T14:30:37.483Z"
}
}
Last updated