Update Payment Availability Period

Sets your payment availability period: how many days unpaid payments stay open before Payment Labs expires them.

Requires the payout Administrator role.

Send both fields. To change one rule only, send the other with its current value from Get Payment Availability Period.

What happens:

  • The new period applies to existing payments too. Payment Labs checks them shortly after you save a period above 0, and
    then periodically, at least once an hour.
  • A payment in DRAFT, WAITING_PAYABILITY or RESTRICTED that was created more than expirationDays days ago moves to
    EXPIRED.
  • A payment in FAILED or RETURNED that has not changed for returnExpirationDays days moves to EXPIRED.
  • Expiring a payment cannot be undone. To pay the payee after that, create a new payment.

Errors

  • 400 INVALID_REQUEST: a value is below 0.
  • 400 VALIDATION_ERROR: a value is not a number, or the body has a field not listed here.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

How long unpaid payments stay open before Payment Labs expires them. 0 turns a rule off.

number
required
≥ 0

Days a payment can stay in DRAFT, WAITING_PAYABILITY or RESTRICTED, counted from its creation, before Payment Labs
expires it. 0 means payments in those statuses never expire.

number
required
≥ 0

Days a payment can stay in FAILED or RETURNED without changing, before Payment Labs expires it. When expirationDays is
also set, the payment must be older than expirationDays too. 0 means failed and returned payments never expire.

Responses
204

The operation succeeded. The response has no body.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json