Read the customer-safe exchange status

GET

/v1/public/exchanges/{id}

curl --request GET \
  --url 'http://localhost:4000/v1/public/exchanges/example?cs=example&cs=<cs>'

Authorizations

• checkoutSecret

Parameters

Path Parameters

id

required

string

Query Parameters

cs

required

string

Responses

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

Invalid input

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Test mode disabled

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Not found

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

409

Invalid or reused quote

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Limit exceeded

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Rate limited

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

503

Unavailable

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}