Skip to content
Xaalis

Test mode: confirm or decline the pay-in and process the exchange

POST
/v1/public/exchanges/{id}/simulate
curl --request POST \
  --url 'http://localhost:4000/v1/public/exchanges/example/simulate?cs=example&cs=<cs>' \
  --header 'Content-Type: application/json' \
  --data '{ "outcome": "succeeded" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string

Query Parameters

Section titled “Query Parameters”
cs
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
outcome
required
string
Allowed values: succeeded failed

Responses

Section titled “ Responses ”

200

Section titled “200”

Exchange

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