Skip to main content
PUT
/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

realmId
string
required
organizationId
string
required
accountId
string
required
walletId
string
required
pixBillingAutomaticId
string
required
pixBillingAutomaticScheduleId
string
required

Body

application/json
amount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
description
string

Response

200 - application/json

Successful response

_id
string
required
environment
enum<string>
required
Available options:
LIVE,
TEST
realmId
string
required
organizationId
string
required
accountId
string
required
walletId
string
required
pixBillingAutomaticId
string
required
amount
number
required
isFirstPayment
boolean
required
status
enum<string>
required
Available options:
CREATED,
SCHEDULED,
CANCELED,
EXPIRED,
FAILED,
SCHEDULE_ERROR,
PAID,
RETRY
description
string
required
scheduledTo
string
required
attempts
object[]
required
external
object
required
error
object
required