APG PayAPG Paydocs

Merchants

Update merchant statement password

PATCH/merchant-statement-passwords/{merchantStatementPasswordId}

Replace the merchant's statement password with a newly generated one. Audited. The answer does not carry the new password: read it, which is audited as a reveal.

Permissions

Required permission
merchantStatementPasswords:update

Requires the `update` action on `merchantStatementPasswords` for the supplied runtime context

Path parameters

merchantStatementPasswordIdstring
required

Request body

This body is a tagged shape: type is always "MspwUpdateReset". Send it; more variants can be added, and a caller that switches on it keeps working when they are.

Discriminated by type
type = "MspwUpdateReset"

This variant has no additional fields.

curl -X PATCH https://api.tst.au.apgpay.dev/merchant-statement-passwords/{merchantStatementPasswordId} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "MspwUpdateReset"
}'

Responses

The response is a tagged shape: type is always "MspwUpdateRspAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "MspwUpdateRspAttributes"

The resource as it stands after the change.

Example
{
  "type": "MspwUpdateRspAttributes",
  "updated": {
    "type": "MspwViewAttributes",
    "merchantStatementPasswordId": "mcht_9f2Kd8QpLzXw",
    "password": "string"
  }
}

Error responses