Skip to content
Xaalis

Test mode: create an exchange with one Idempotency-Key

POST
/v1/public/exchanges
curl --request POST \
  --url http://localhost:4000/v1/public/exchanges \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --data '{ "quote": "example", "otp": "example" }'

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
idempotency-key
required
string
>= 1 characters <= 255 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
quote
required
string
otp
required
string
>= 6 characters <= 6 characters
Examplegenerated
{
  "quote": "example",
  "otp": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201”

Exchange and checkout link

Media typeapplication/json
object
object
required
string
Allowed values: exchange
id
required
string
status
required
string
Allowed values: awaiting_payment paid payout_processing completed expired refunding refunded needs_review
from
required
string
Allowed values: wave orange_money
to
required
string
Allowed values: wave orange_money
send_amount
required
integer
fee
required
integer
receive_amount
required
integer
currency
required
string
Allowed values: XOF
livemode
required
boolean
created_at
required
string
checkout_url
required
string
cs
required
string
Example
{
  "object": "exchange",
  "status": "awaiting_payment",
  "from": "wave",
  "to": "wave",
  "currency": "XOF",
  "livemode": false
}

400

Section titled “400”

Invalid input

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403”

Test mode disabled

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Section titled “409”

Invalid or reused quote

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Section titled “422”

Limit exceeded

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Section titled “429”

Rate limited

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

503

Section titled “503”

Unavailable

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}