Skip to main content
PUT
Update seller billing mandate readiness (admin)

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

mandateUid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Compare-and-swap update to the mandate-readiness projection. Ready is accepted only for the current active/effective mandate and complete current advertiser identities. Caller-authored reason codes and summaries reject payment- or provider-credential-shaped content before persistence.

idempotencyKey
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
expectedMandateRevision
integer
required
Required range: 0 < x <= 9007199254740991
expectedReadinessRevision
integer
required
Required range: 0 <= x <= 9007199254740991
status
enum<string>
required
Available options:
pending,
ready,
failed,
hold
reasonCode
string
required
Maximum string length: 100
Pattern: ^[a-z0-9]+(?:_[a-z0-9]+)*$
reasonSummary
string
required
Required string length: 1 - 500

Response

Update seller billing mandate readiness (admin)

data
object
required
error
enum<string> | null
required
Available options:
null