Read your WhatsApp payout PIN and merchant cap status (owner only)

GET

/dashboard/v1/merchants/{merchantId}/{mode}/whatsapp/payout-settings

curl --request GET \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/whatsapp/payout-settings \
  --cookie better-auth.session_token=<better-auth.session_token>

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

Responses

200

PIN and cap status without secrets

Media typeapplication/json

object

object

required

string

Allowed values: whatsapp_payout_settings

pin_set

required

boolean

pin_locked

required

boolean

pin_change_effective_at

required

string | null

unlock_effective_at

required

string | null

daily_cap

required

integer

pending_cap

required

Integer XOF

integer | null

>= 1 <= 100000000

cap_change_effective_at

required

string | null

link_hold_until

required

string | null

Example

{
  "object": "whatsapp_payout_settings",
  "pending_cap": 15000
}

400

Invalid request

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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

401

Sign-in required

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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

403

Forbidden

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

Idempotency conflict or invalid state

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

details

Example^generated

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