Skip to main content
PUT
cURL
Update one future transaction using its future_transaction_id and recurring_id. Supply an optional amount, scheduled date, or both. Use recurring update to update the recurring series instead.

Authorizations

x-api-key
string
header
required

Path Parameters

terminal_friendly_id
string
required

The unique identifier of the terminal.

Required string length: 6
Pattern: ^[\dA-Za-z]{6}$

Body

application/json
future_transaction_id
string
required

The future transaction identifier to update.

Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
recurring_id
string
required

The recurring subscription identifier this future transaction belongs to.

Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
amount
number

New payment amount in major currency units (e.g. 10.00 for $10.00 USD).

Required range: 0.01 <= x <= 999999.99
scheduled_date
string

New scheduled date (ISO 8601 datetime). Must be in the future.

Response

Default Response

recurring_id
string
required
Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
future_transaction_id
string
required
Required string length: 8
Pattern: ^[\dA-Za-z]{8}$
updated
boolean
required