Sign in
Payments

Put PAD order on hold

Put a PAD order on hold to pause the collection flow for a set amount of time.

post/pad/orders/{order_id}/onhold

Path parameters

order_idstring required

The unique identifier of the order.

Max length: 50 characters.

Request body

durationinteger

The duration of the hold in seconds. If you omit duration, it defaults to 864000 (10) days.

Example request

{
  "duration": 1209600
}

Response

Request successful

datastring date-time

When the collection flow will resume. Format: ISO 8601 time

successSuccess — unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.