APG PayAPG Paydocs

Merchants

Get merchant statement password

GET/merchant-statement-passwords/{merchantStatementPasswordId}
Request
GEThttps://api.tst.au.apgpay.dev/merchant-statement-passwords/{merchantStatementPasswordId}
curl -X GET https://api.tst.au.apgpay.dev/merchant-statement-passwords/{merchantStatementPasswordId} \
  -H "Authorization: Bearer $API_KEY"

Reveal the merchant's statement password. Audited: the read is recorded with who made it.

Permissions

Required permission
merchantStatementPasswords:update

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

Path parameters

merchantStatementPasswordIdstring
required

Responses

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

Discriminated by type
type = "MspwViewAttributes"
merchantStatementPasswordIdMspwIdrequired

Identifier of a merchant's statement password, which is the merchant's own identifier.

Example mcht_9f2Kd8QpLzXw

passwordstring

The password in clear. Present only on a read: a reset answers without it, so that revealing it is a read of its own, and audited as one.

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

Error responses