Make a swap

POST

exchange

swap

{
  "data": {
    "correlation_id": "7da742ea-a1bc-11ee-b907-560f156a658b",
    "created_at": "2021-01-01T00:00:00Z",
    "customer": {
      "email": "customer@email.com",
      "id": "1",
      "name": "User 1",
      "type": "user"
    },
    "id": "7da8e726-a1bc-11ee-80cf-560f156a658b",
    "provider": {
      "email": "provider@email.com",
      "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"
  }
}

Body

application/json

Swap params

amount

integer

required

Amount, in minor units

source_currency

string

required

Source currency

target_currency

string

required

Target currency

Response

200

application/json

Swap Details

Response schema for swap

data

object

Swap details

data.correlation_id

string

Correlation ID

data.created_at

string

Creation timestamp

data.customer

object

Profile Details

Example:

{
  "email": "customer@email.com",
  "id": "1",
  "name": "User 1",
  "type": "user"
}

data.fee_amount

number

Fee Amount

data.fee_currency

string

Fee Currency

data.id

string

data.provider

object

Profile Details

Example:

{
  "email": "customer@email.com",
  "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

Update timestamp

Example:

{
  "correlation_id": "7da742ea-a1bc-11ee-b907-560f156a658b",
  "created_at": "2021-01-01T00:00:00Z",
  "customer": {
    "email": "customer@email.com",
    "id": "1",
    "name": "User 1",
    "type": "user"
  },
  "id": "7da8e726-a1bc-11ee-80cf-560f156a658b",
  "provider": {
    "email": "provider@email.com",
    "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"
}

List swaps Retrieve an order

{
  "data": {
    "correlation_id": "7da742ea-a1bc-11ee-b907-560f156a658b",
    "created_at": "2021-01-01T00:00:00Z",
    "customer": {
      "email": "customer@email.com",
      "id": "1",
      "name": "User 1",
      "type": "user"
    },
    "id": "7da8e726-a1bc-11ee-80cf-560f156a658b",
    "provider": {
      "email": "provider@email.com",
      "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"
  }
}

exchange

payouts

payment-lifecycle

Body

Response