Skip to content
Xaalis

Confirm a WhatsApp payout with the owner PIN

POST
/v1/public/whatsapp/payout-intents/{token}/confirm
curl --request POST \
  --url http://localhost:4000/v1/public/whatsapp/payout-intents/example/confirm \
  --header 'Content-Type: application/json' \
  --data '{ "pin": "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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
pin
required
string
/^\d{6}$/
Examplegenerated
{
  "pin": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Admitted or replayed payout

Media typeapplication/json
object
id
required
string
object
required
string
Allowed values: payout
agent_wallet_id
required
string | null
livemode
required
boolean
amount
required
integer
fee
required
integer
currency
required
string
provider
required
string
Allowed values: wave orange_money mock
status
required
string
Allowed values: pending processing succeeded failed
recipient
required
object
phone
required
string
name
required
string | null
client_reference
required
string | null
failure_reason
required
string | null
created_at
required
string
updated_at
required
string
Example
{
  "object": "payout",
  "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"
  }
}