List swaps

curl --request GET \
  --url https://api.example.com/exchange/swap

{
  "data": [
    {
      "correlation_id": "7da742ea-a1bc-11ee-b907-560f156a658b",
      "created_at": "2021-01-01T00:00:00Z",
      "customer": {
        "email": "[email protected]",
        "id": "1",
        "name": "User 1",
        "type": "user"
      },
      "id": "7da8e726-a1bc-11ee-80cf-560f156a658b",
      "provider": {
        "email": "[email protected]",
        "id": "1",
        "name": "Provider 1",
        "type": "provider"
      },
      "source_amount": {
        "amount": 1,
        "currency": "USD"
      },
      "status": "success",
      "symbol": "USD-NGN",
      "target_amount": {
        "amount": 1000,
        "currency": "NGN"
      },
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "after": "b101f718-d133-450c-a572-c281c7341803",
    "before": null,
    "limit": 15
  }
}

GET

exchange

swap

List swaps

curl --request GET \
  --url https://api.example.com/exchange/swap

{
  "data": [
    {
      "correlation_id": "7da742ea-a1bc-11ee-b907-560f156a658b",
      "created_at": "2021-01-01T00:00:00Z",
      "customer": {
        "email": "[email protected]",
        "id": "1",
        "name": "User 1",
        "type": "user"
      },
      "id": "7da8e726-a1bc-11ee-80cf-560f156a658b",
      "provider": {
        "email": "[email protected]",
        "id": "1",
        "name": "Provider 1",
        "type": "provider"
      },
      "source_amount": {
        "amount": 1,
        "currency": "USD"
      },
      "status": "success",
      "symbol": "USD-NGN",
      "target_amount": {
        "amount": 1000,
        "currency": "NGN"
      },
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "after": "b101f718-d133-450c-a572-c281c7341803",
    "before": null,
    "limit": 15
  }
}

Query Parameters

before

string

Cursor

after

string

After

limit

integer

Limit

symbol

string

Swap symbol

Response

200 - application/json

Swap List

Response schema for multiple swaps

data

SwapDetails · object[]

Swap list

Show child attributes

data.client_reference

string | null

Reference

data.correlation_id

string

Correlation ID

data.created_at

string<date-time>

Creation timestamp

data.customer

Profile · object

Profile Details

Show child attributes

data.customer.email

string | null

Provider email

data.customer.id

string

Provider ID

data.customer.name

string | null

Provider name

data.customer.type

string

Provider type

Example:

{
  "email": "[email protected]",
  "id": "1",
  "name": "User 1",
  "type": "user"
}

data.fee_amount

number

Fee Amount

data.fee_currency

string

Fee Currency

data.id

string

data.provider

Profile · object

Profile Details

Show child attributes

data.provider.email

string | null

Provider email

data.provider.id

string

Provider ID

data.provider.name

string | null

Provider name

data.provider.type

string

Provider type

Example:

{
  "email": "[email protected]",
  "id": "1",
  "name": "User 1",
  "type": "user"
}

data.source_amount

number

Source Amount

data.source_currency

string

Source Currency

data.status

enum<string>

Available options:

pending,

success,

failed

data.symbol

string

Currency pair

data.target_amount

number

Target Amount

data.target_currency

string

Target Currency

data.updated_at

string<date-time>

Update timestamp

pagination

Pagination · object

Show child attributes

pagination.after

string | null

After cursor

pagination.before

string | null

Before cursor

pagination.limit

integer

Limit

Example:

{
  "after": "b101f718-d133-450c-a572-c281c7341803",
  "before": null,
  "limit": 15
}

Create a market maker Make a swap

⌘I

exchange

payouts

payments

Swaps

Orders

wallets

List swaps

Query Parameters

Response