Skip to content
Xaalis

Show one-time WhatsApp payout proposal on the Xaalis PIN page

GET
/v1/public/whatsapp/payout-intents/{token}
curl --request GET \
  --url http://localhost:4000/v1/public/whatsapp/payout-intents/example

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
token
required

Five-minute single-use PIN link token; keep it out of logs and analytics

string

Five-minute single-use PIN link token; keep it out of logs and analytics

Responses

Section titled “ Responses ”

200

Section titled “200”

Payout proposal

Media typeapplication/json
object
object
required
string
Allowed values: whatsapp_payout_intent
id
required
string
amount
required
integer
currency
required
string
Allowed values: XOF
business_name
required
string
recipient
required
object
provider
required
string
Allowed values: wave orange_money
phone
required
string
status
required
string
Allowed values: pending admitted
expires_at
required
string
Example
{
  "object": "whatsapp_payout_intent",
  "currency": "XOF",
  "recipient": {
    "provider": "wave"
  },
  "status": "pending"
}

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

401

Section titled “401”

Incorrect PIN

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”

Payout 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”

Unknown or expired link

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

422

Section titled “422”

Daily cap exceeded

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”

Reservation unavailable; retry this link

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