Set or reset your WhatsApp payout PIN (owner only)

PUT

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

curl --request PUT \
  --url http://localhost:4000/dashboard/v1/merchants/example/test/whatsapp/payout-pin \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --cookie better-auth.session_token=<better-auth.session_token> \
  --data '{ "pin": "example" }'

Authorizations

• dashboardSession

Parameters

Path Parameters

merchantId

required

string

mode

required

string

Allowed values: test live

Header Parameters

idempotency-key

required

Required retry-safe key; reuse it only for the same operation and request body

string

>= 1 characters <= 255 characters

Required retry-safe key; reuse it only for the same operation and request body

Request Body^required

Media typeapplication/json

object

pin

required

string

/^\d{6}$/

Example^generated

{
  "pin": "example"
}

Responses

200

PIN effective time; resets wait 24 hours

Media typeapplication/json

object

object

required

string

Allowed values: whatsapp_payout_pin

effective_at

required

string

Example

{
  "object": "whatsapp_payout_pin"
}

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