Skip to main content
Find where payments are in their lifecycle and identify the records that need attention. This workflow produces counts and amounts by status, plus a list of payments whose stored status is eligible for a cancellation review.

​
Before you begin

  • Install the Straddle CLI and configure an API key for the environment you want to inspect.
  • Confirm your integration type and acting account. SaaS and marketplace integrations select the account being investigated.
  • Use the same environment, acting account, and database throughout. For a custom database, add the same --db PATH to each sync and pipeline command.

​
Run the workflow

1

Confirm the account and environment

Check runtime_context.environment, runtime_context.integration_type, and runtime_context.acting_account. The environment is the API origin. Direct account integrations show a null acting account.For SaaS or marketplace, select the account if needed, then check the context again:
2

Refresh payment records

This fetches charges and payouts from the start of the resource, without the default page limit. Confirm a sync_complete event and a final sync_summary with success: 1, warned: 0, and errored: 0. Review any sync_warning or sync_anomaly before relying on the report; those findings can accompany exit code zero.
3

Inspect the status groups

The report groups all stored payments in the selected context by status. To list the individual cancellation candidates:
4

Retrieve current payment details

Use the candidate’s type to choose the command. Replace PAYMENT_ID with its id.
For a payout:
Review the current status and status details before deciding how to handle the payment.

​
Interpret the results

The --cancelable result is an array of payments with id, type, status, amount, and cancelable. A value of 12500 in an amount field represents $125.00.
Cancellation candidates are selected from stored statuses. A payment may have progressed since synchronization. Its current status, hold details, and the permissions of your API key determine the action available when you make the request.

​
Complete the investigation

Use the payment status guide to interpret the current state. Record the payment ID and the action or follow-up it requires. For failed or reversed payments, continue with failure and return investigation. For funding questions, reconcile the payment.