Skip to content
Xaalis

Customer chose a payment method

POST
/v1/public/payments/{id}/pay
curl --request POST \
  --url 'http://localhost:4000/v1/public/payments/example/pay?cs=example' \
  --header 'Content-Type: application/json' \
  --data '{ "provider": "wave", "phone": "+221771234567" }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
id
required
string

Query Parameters

Section titled “Query Parameters”
cs
required

Payment client secret

string

Payment client secret

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
provider
required
string
Allowed values: wave orange_money
phone
string
/^\+2217[0-9]{8}$/
Example
+221771234567

Responses

Section titled “ Responses ”

200

Section titled “200”

Payment with next_action

Media typeapplication/json
object
id
required
string
livemode
required
boolean
amount
required
integer
currency
required
string
status
required
string
Allowed values: requires_payment_method processing succeeded failed expired refunded
description
required
string | null
merchant
required
object
name
required
string
provider
required
string | null
Allowed values: wave orange_money mock
available_providers
required
Array<string>
Allowed values: wave orange_money
next_action
required
Any of:
object
type
required
string
Allowed values: redirect
url
required
string
expires_at
required
string
return_url
required

Where to send the customer once status is terminal

string | null
Example
{
  "status": "requires_payment_method",
  "provider": "wave",
  "available_providers": [
    "wave"
  ],
  "next_action": {
    "type": "redirect"
  }
}

400

Section titled “400”

Validation error

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 state

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; see Retry-After response header

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