Endpoints

Wallets

Wallet module endpoints:

GET /wallets

GET https://api.slyk.io/wallets

Retrieves a paginated list of wallets.

Available Filters
Available Sorts
Response
Available Filters

Name

Type

Example

id

= in nin

filter[id]=in:fc78d28f-a8dd-49de-a22f-722fe3bd26c7

locked

=

filter[locked]=true

name

like

filter[name]=foobar

ownerId

=

filter[ownerId]=3feaac72-7330-4b32-9801-28b6f69aaf25

reference

=

filter[reference]=123456789A

The name filter performs a SQL query using the like operator.

Available Sorts

Name

Example

createdAt

sort=createdAt

Response
{
"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 https://api.slyk.io/wallets/:id

Gets the wallet details of the given id.

Response
Response
{
"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 https://api.slyk.io/wallets/:id/activity

Returns the wallet activity of the given id.

Available Filters
Available Sorts
Available Includes
Response
Available Filters

Name

Type

Example

assetCode

= in nin

filter[assetCode]=in:ltc

code

= in nin

filter[code]=in:issue

status

= in nin

filter[status]=in:pending

type

= in nin

filter[type]=in:deposit

Available Sorts

Name

Example

amount

sort=amount

createdAt

sort=-createdAt

Available Includes

Name

Example

users

include=users

wallets

include=wallets

Response
{
"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": "[email protected]",
"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": "[email protected]",
"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 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).

Available Filters
Response
Available Filters

Name

Type

Example

assetCode

= in nin

filter[assetCode]=in:btc,eth,ltc

Response
{
"data": [
{ "assetCode": "bar", "amount": "10.00000000" },
{ "assetCode": "biz", "amount": "3.50000000"}
]
}

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.

Available Filters
Available Sorts
Available Includes
Response
Available Filters

Name

Type

Example

assetCode

= in nin

filter[assetCode]=in:eur,btc

Available Sorts

Name

Example

amount

sort=amount

createdAt

sort=-createdAt

Available Includes

Name

Example

transaction

include=transaction

Response
{
"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 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.

Available Filters
Available Sorts
Response
Available Filters

Name

Type

Example

assetCode

= in nin

filter[assetCode]=in:usd,eur

code

= in nin

filter[code]=in:issue

status

= in nin

filter[status]=in:pending

type

= in nin

filter[type]=in:deposit

Available Sorts

Name

Example

amount

sort=amount

createdAt

sort=-createdAt

Response
{
"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 https://api.slyk.io/wallets/activity

Returns the wallets activity.

Available Filters
Available Sorts
Available Includes
Response
Available Filters

Name

Type

Example

assetCode

= in nin

filter[assetCode]=in:btc

code

= in nin

filter[code]=in:issue

status

= in nin

filter[status]=in:pending

type

= in nin

filter[type]=in:deposit

Available Sorts

Name

Example

amount

sort=amount

createdAt

sort=-createdAt

Available Includes

Name

Example

users

include=users

wallets

include=wallets

Response
{
"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": "[email protected]",
"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": "[email protected]",
"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 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).

Available Filters
Response
Available Filters

Name

Type

Example

assetCode

= in nin

filter[assetCode]=in:usd,eur

Response
{
"data": [
{ "assetCode": "bar", "amount": "10.00000000" },
{ "assetCode": "biz", "amount": "3.50000000"}
]
}

PATCH /wallets/:id

PATCH https://api.slyk.io/wallets/:id

Patch the wallet details of the given id.

Request Parameters
Request
Response
Request Parameters

Name

Type

Required

Description

customData

object

false

Custom data object

locked

boolean

false

Wallet lock status

ownerId

string

false

Wallet owner userid

Request
{
"customData": {
"description": "Someone's first wallet"
}
}
Response
{
"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 https://api.slyk.io/wallets

Creates a new wallet.

Request Parameters
Request
Response
Request Parameters

Name

Type

Required

Description

customData

object

false

Custom data object

locked

boolean

false

Wallet lock status

name

string

false

Wallet Name

ownerId

string

false

Wallet owner user id

Request
{
"name": "Savings",
"ownerId": "0bf8ee88-aed1-442c-a191-ffcee735b38a"
}
Response

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"
}
}

Transactions

Transaction module endpoints:

GET /transactions

GET https://api.slyk.io/transactions

Retrieves a paginated list of transactions.

Available Filters
Available Sorts
Paginate Options
Response
Available Filters

Name

Type

Example

assetCode

= in nin

filter[assetCode]=in:USD,EUR,BTC

code

= in nin

filter[code]=in:internal,bank:wire

createdAt

= gte lte

filter[createdAt]=lte:2019-07-21

description

like

filter[description]=some description excerpt

destinationWalletId

= in nin

filter[destinationWalletId]=705af61e-1387-49b0-90f8-45c39fe56686

externalId

= in nin

filter[externalId]=in:3feaac72-7330-4b32-9801-28b6f69aaf25,705af61e-1387-49b0-90f8-45c39fe56686

externalReference

=

filter[externalReference]=thud

id

= in nin

filter[id]=nin:802a5163-7ad3-4047-b600-088c1f746733,9d3bed88-34b6-4a06-aa79-ed4b32ba0d44

originWalletId

= in nin

filter[originWalletId]=705af61e-1387-49b0-90f8-45c39fe56686

reference

=

filter[originWalletId]=waldo

status

= in nin

filter[status]=nin:pending,failed,rejected

type

= in nin

filter[type]=in:deposit

walletId

= in nin

filter[walletId]=802a5163-7ad3-4047-b600-088c1f746733

The description filter performs a SQL query using the like operator.

The walletId filter will return any transaction where its set as destinationWalletId or originWalletId.

Available Sorts

Name

Example

amount

sort=amount sort=-amount

createdAt

sort=createdAt sort=-createdAt

Paginate Options

Name

Description

Example

size

Defines the number of results per page. Default = 30.

page[size]=2

number

Defines the number of the page to retrieve. Default = 1

page[number]=2

Response
{
"data": [
{
"amount": "10.00000000",
"assetCode": "usd",
"code": "internal",
"createdAt": "2019-07-20T14:30:37.483Z",
"customData": {},
"description": "A withdrawal transaction so `destinationWalletId` is `null`",
"destinationAddress": null,
"destinationWalletId": null,
"externalId": null,
"externalReference": null,
"id": "02731cf6-7452-424b-905e-f11d05715585",
"metadata": {},
"originAddress": null,
"originWalletId": "2c9cf763-4103-4b5e-9e44-d350af41117a",
"status": "pending",
"type": "withdrawal",
"updatedAt": "2019-07-20T14:30:37.483Z"
},
{
"amount": "1234.5678",
"assetCode": "biz",
"code": "internal",
"createdAt": "2019-07-20T14:30:37.483Z",
"customData": {},
"description": "A deposit transaction so `originWalletId` field is `null`",
"destinationAddress": null,
"destinationWalletId": "2a5489f2-73a5-4cba-a6b2-0b77b1ad94ce",
"externalId": null,
"externalReference": null,
"id": "6042126c-9f63-4e47-b336-55ee56493826",
"metadata": { "foo": "bar" },
"originAddress": null,
"originWalletId": null,
"status": "rejected",
"type": "deposit",
"updatedAt": "2019-07-20T14:30:37.483Z"
}
],
"total": 1
}

GET /transactions/:id

GET https://api.slyk.io/transactions/:id

Retrieves the transactions of the given id.

Response
Response
{
"data": {
"amount": "10.00",
"assetCode": "usd",
"code": "internal",
"createdAt": "2019-07-20T14:30:37.483Z",
"customData": {},
"description": "A deposit transaction so `originWalletId` field is `null`",
"destinationAddress": null,
"destinationWalletId": "2a5489f2-73a5-4cba-a6b2-0b77b1ad94ce",
"externalId": null,
"externalReference": null,
"id": "35589275-5db3-4b99-88cc-0bbdaa94ae8f",
"metadata": {},
"originAddress": null,
"originWalletId": null,
"status": "rejected",
"type": "deposit",
"updatedAt": "2019-07-20T14:30:37.483Z"
}
}

POST /transactions/:id/approve

POST https://api.slyk.io/transactions/:id/approve

Approves the transaction of the given id.

Its only possible to approve transactions that are pending.

Response
Response
{
"data": {
"amount": "9800.00000000",
"assetCode": "eur",
"code": "bank:wire",
"createdAt": "2019-07-20T14:30:37.483Z",
"customData": {
"month": "03",
"year": "2020"
}
"description": "Salary",
"destinationAddress": null,
"destinationWalletId": null,
"externalId": null,
"externalReference": null,
"id": "35589275-5db3-4b99-88cc-0bbdaa94ae8f",
"metadata": {
"transactionData": {
"bankAddress": "Tussen Meer 375C, 1069 DR Amsterdam",
"bankName": "IGN",
"country": "Netherlands",
"iban": "NL64INGB8219153XXX",
"swiftCode": "INGBNL2AXXX"
}
},
"originAddress": null,
"originWalletId": "167d4b2b-5607-47d1-b54a-fb9036bf40dd",
"status": "processing",
"type": "withdrawal",
"updatedAt": "2019-07-20T14:30:37.483Z"
}
}
}

POST /transactions/:id/confirm

POST https://api.slyk.io/transactions/:id/confirm

Confirms the transaction of the given id.

Response
Response
{
"data": {
"amount": "9800.00000000",
"assetCode": "eur",
"code": "bank:wire",
"createdAt": "2019-07-20T14:30:37.483Z",
"customData": {
"month": "03",
"year": "2020"
}
"description": "Salary",
"destinationAddress": null,
"destinationWalletId": null,
"externalId": null,
"externalReference": null,
"id": "35589275-5db3-4b99-88cc-0bbdaa94ae8f",
"metadata": {
"transactionData": {
"bankAddress": "Tussen Meer 375C, 1069 DR Amsterdam",
"bankName": "IGN",
"country": "Netherlands",
"iban": "NL64INGB8219153XXX",
"swiftCode": "INGBNL2AXXX"
}
},
"originAddress": null,
"originWalletId": "167d4b2b-5607-47d1-b54a-fb9036bf40dd",
"status": "completed",
"type": "withdrawal",
"updatedAt": "2019-07-20T14:30:37.483Z"
}
}

POST /transactions/:id/fail

POST https://api.slyk.io/transactions/:id/fail

Fails the transaction of the given id.

Request Parameters
Request
Response
Request Parameters

Field

Type

Required

Description

reason

string

false

Fail reason.

Request
{
"reason": "Invalid IBAN."
}
Response
{
"data": {
"amount": "9800.00000000",
"assetCode": "eur",
"code": "bank:wire",
"createdAt": "2019-07-20T14:30:37.483Z",
"customData": {
"month": "03",
"year": "2020"
}
"description": "Salary",
"destinationAddress": null,
"destinationWalletId": null,
"externalId": null,
"externalReference": null,
"id": "35589275-5db3-4b99-88cc-0bbdaa94ae8f",
"metadata": {
"failReason": "Invalid IBAN.",
"transactionData": {
"bankAddress": "Tussen Meer 375C, 1069 DR Amsterdam",
"bankName": "IGN",
"country": "Netherlands",
"iban": "NL64INGB8219153XXX",
"swiftCode": "INGBNL2AXXX"
}
},
"originAddress": null,
"originWalletId": "167d4b2b-5607-47d1-b54a-fb9036bf40dd",
"status": "processing",
"type": "withdrawal",
"updatedAt": "2019-07-20T14:30:37.483Z"
}
}
}

POST /transactions/:id/reject

POST https://api.slyk.io/transactions/:id/reject

Rejects the transaction of the given id.

Its only possible to reject transactions that are pending.

Request Parameters
Request
Response
Request Parameters

Field

Type

Required

Description

reason

string

false

Reject reason.

Request
{
"reason": "Wrong amount."
}
Response
{
"data": {
"amount": "9800.00000000",
"assetCode": "eur",
"code": "bank:wire",
"createdAt": "2019-07-20T14:30:37.483Z",
"customData": {
"month": "03",
"year": "2020"
}
"description": "Salary",
"destinationAddress": null,
"destinationWalletId": null,
"externalId": null,
"externalReference": null,
"id": "35589275-5db3-4b99-88cc-0bbdaa94ae8f",
"metadata": {
"rejectedReason": "Wrong amount.",
"transactionData": {
"bankAddress": "Tussen Meer 375C, 1069 DR Amsterdam",
"bankName": "IGN",
"country": "Netherlands",
"iban": "NL64INGB8219153XXX",
"swiftCode": "INGBNL2AXXX"
}
},
"originAddress": null,
"originWalletId": "167d4b2b-5607-47d1-b54a-fb9036bf40dd",
"status": "rejected",
"type": "withdrawal",
"updatedAt": "2019-07-20T14:30:37.483Z"
}
}

POST /transactions/deposit

POST https://api.slyk.io/transactions/deposit

Creates a new deposit transaction.

Request Parameters
Codes
Request
Response
Request Parameters

Field

Type

Required

Description

amount

string

true

Transacted amount.

assetCode

string

true

Code of the asset being transacted.

code

string

true

Defines through which feature and method the assets will be deposited (more information below).

commit

boolean

false

Transaction is created already as processing. Only available for crypto, bank and internal code features. Default: false.

customData

object

false

Stores any additional information the user may provide.

data

object

true

May contain necessary data for the payment gateway. The information required in this field depends on the provided code method.

description

string

false

A free text field.

destinationAddress

string

false

Destination address.

destinationWalletId

string

true

ID of the wallet where the assets are being deposited. Format: uuid.

externalReference

string

false

External reference.

Codes

Feature

Methods

Example

apm

paypal

apm:paypal

bank

wire

bank:wire

card

stripe

card:stripe

crypto

coinbase, ethereum

crypto:bitcoin

internal

-

internal

Request
{
"amount": "20",
"assetCode": "USD",
"code": "apm:paypal",
"customData": { "foo": "bar" },
"data": { "description": "paypal payment" },
"description": "Some description",
"destinationAddress": "foo",
"destinationWalletId": "7eb44aff-bb08-4374-856c-98f297324dac"
}
Response
  • apm:paypal example:

{
"data": {
"amount": "20.00000000",
"assetCode": "USD",
"code": "apm:paypal",
"createdAt": "2019-07-20T14:30:37.483Z",
"customData": { "foo": "bar" },
"description": "Some description",
"destinationAddress": "foo",
"destinationWalletId": "7eb44aff-bb08-4374-856c-98f297324dac",
"externalId": null,
"externalReference": null,
"id": "35589275-5db3-4b99-88cc-0bbdaa94ae8f",
"metadata": {
"gatewayResponse": {
"id": "0fbe6d55-5b83-4bfb-97b3-53b9ef9d4957",
"metadata": {
"amount": "20.00000000",
"..."
},
"..."
},
"paymentMethod": "paypal"
},
"originAddress": null,
"originWalletId": null,
"status": "pending",
"type": "deposit",
"updatedAt": "2019-07-20T14:30:37.483Z"
}
}
  • bank:wire example:

{
"data": {
"amount": "20.00000000",
"assetCode": "EUR",
"code": "bank:wire",
"createdAt": "2019-07-20T14:30:37.483Z",
"customData": { "foo": "bar" },
"description": "Some description",
"destinationAddress": "foo",
"destinationWalletId": "7eb44aff-bb08-4374-856c-98f297324dac",
"externalId": null,
"externalReference": null,
"id": "35589275-5db3-4b99-88cc-0bbdaa94ae8f",
"metadata": {},
"originAddress": null,
"originWalletId": null,
"status": "pending",
"type": "deposit",
"updatedAt": "2019-07-20T14:30:37.483Z"
}
}
  • card:stripe example:

{
"data": {
"amount": "20.00000000",
"assetCode": "USD",
"code": "card:stripe",
"createdAt": "2019-07-20T14:30:37.483Z",
"customData": { "foo": "bar" },
"description": "Some description",
"destinationAddress": "foo",
"destinationWalletId": "7eb44aff-bb08-4374-856c-98f297324dac",
"externalId": null,
"externalReference": null,
"id": "35589275-5db3-4b99-88cc-0bbdaa94ae8f",
"metadata": {
"gatewayResponse": {
"id": "0fbe6d55-5b83-4bfb-97b3-53b9ef9d4957",
"metadata": {
"amount": "20.00000000",
"..."
},
"..."
},
"paymentMethod": "stripe"
},
"originAddress": null,
"originWalletId": null,
"status": "pending",
"type": "deposit",
"updatedAt": "2019-07-20T14:30:37.483Z"
}
}
  • internal example:

{
"data": {
"amount": "100.00000000",
"assetCode": "SLK",
"code": "internal",
"createdAt": "2019-07-20T14:30:37.483Z",
"customData": { "foo": "bar" },
"description": "Some description",
"destinationAddress": "foo",
"destinationWalletId": "7eb44aff-bb08-4374-856c-98f297324dac",
"externalId": null,
"externalReference": null,
"id": "35589275-5db3-4b99-88cc-0bbdaa94ae8f",
"metadata": {},
"originAddress": null,
"originWalletId": null,
"status": "pending",
"type": "deposit",
"updatedAt": "2019-07-20T14:30:37.483Z"
}
}

POST /transactions/pay

POST https://api.slyk.io/transactions/pay

Creates a new transfer transaction with the code set to pay and set the defaultWalletId as the destinationWalletId.

Request Parameters
Request
Response
Request Parameters

Name

Type

Required

Description

amount

string

true

Transacted amount.

assetCode

string

true

Code of the asset being transacted.

customData

object

false

Stores any additional information the user may provide.

description

string

false

A free text field.

originWalletId

string

true

ID of the wallet from where the assets are coming. Format: uuid.

Request
{
"amount": "30",
"assetCode": "usd",
"customData": {
"month": "03",
"year": "2020"
},
"description": "Monthly Fee",
"originWalletId": "97821ce5-bfc7-4185-b263-3233d97b95ec"
}
Response
{
"data": {
"amount": "30.00000000",
"assetCode": "usd",
"code": "pay",
"createdAt": "2019-02-04T18:59:58.168Z",
"customData": {
"month": "03",
"year": "2020"
},
"description": "Monthly Fee",
"destinationAddress": null,
"destinationWalletId": "9afa8a2d-023a-4040-b591-c03077f43d23",
"externalId": null,
"id": "5f054ed2-7374-460f-800d-4e82f4e03d24",
"metadata": {},
"originAddress": null,
"originWalletId": "97821ce5-bfc7-4185-b263-3233d97b95ec",
"status": "pending",
"type": "transfer",
"updatedAt": "2019-02-04T18:59:58.168Z"
}
}

POST /transactions/transfer

POST https://api.slyk.io/transactions/transfer

Creates a new transfer transaction.

Request Parameters
Codes
Request
Response
Request Parameters

Field

Type

Required

Description

amount

string

true

Transacted amount.

assetCode

string

true

Code of the asset being transacted.

code

string

true

Defines through which feature and method the assets will be transfered.

commit

boolean

false

Confirms the transaction on creation. Default: false.

customData

object

false

Stores any additional information the user may provide.

description

string

false

A free text field.

destinationAddress

string

false

Destination address.

destinationWalletId

string

true

ID of the wallet where the assets are being deposited. Format: uuid.

externalReference

string

false

External Reference.

originAddress

string

false

Origin address.

originWalletId

string

true

ID of the wallet from where the assets are coming. Format: uuid.

Codes

Feature

Methods

Example

internal

-

internal

Request
{
"amount": "7.33",
"assetCode": "usd",
"code": "internal",
"commit": true,
"customData": {
"pizzaPrice": "21.99",
"groupSize": "3"