Changelog

Changes for August 27, 2025

API changes

New Pay In capture functionality

We’ve updated our Pay In capture functionality to provide more flexibility and better support for partial captures. The GET capture endpoint will be sunset on November 24, 2025.

• Added POST /MoneyIn/capture/{transId}: Introduced a new POST endpoint for capturing authorized transactions with enhanced functionality:
  • Partial capture support: Capture amounts as low as 85% of the original authorization
  • Flexible service fee adjustments: Adjust service fees proportionally or as needed when capturing partial amounts
  • JSON request body: More structured and flexible than URL parameters
  • Enhanced validation: Better error handling and validation for capture amounts
• Deprecated GET /MoneyIn/capture/{transId}/{amount}: This endpoint is deprecated and will be removed on November 24, 2025. The GET endpoint only supports capturing the exact authorized amount and can’t handle partial captures or service fee adjustments. All integrations should migrate to the new POST endpoint.

The new POST endpoint provides all the functionality of the GET endpoint plus additional capabilities for partial captures and service fee adjustments.

For full migration guidance and examples, see our updated Authorize and capture transactions guide, which includes:

• Step-by-step migration instructions
• Side-by-side examples of old vs. new endpoint usage
• Real-world scenarios for partial captures
• Best practices for handling captures below the 85% threshold

New EventsData field in batch query responses

Query/batches endpoints: Added new EventsData field to batch records to provide detailed event history for each batch.

• New field: EventsData - Array of events associated with each batch
• Event details include:
  • description: Human-readable event description (for example: “Created”, “Closed”)
  • eventTime: Timestamp when the event occurred
  • refData: Reference data related to the event
  • extraData: Additional contextual information
  • source: Source of the event (for example: “api”, “worker”)

This enhancement provides visibility into batch lifecycle events, enabling better tracking of batch processing states and history.

Documentation updates

As part of an ongoing effort to better align the documentation with the API, we’ve updated the Query/batches response schemas. These changes affect the documentation only, the API itself was already returning this data.

Enhanced batch query response documentation

Query/batches endpoints: Updated response schema documentation to accurately reflect the data structure returned by the API:

Improved field organization

• Reorganized batch record fields to match actual API response structure
• Standardized field types to use appropriate nullable types
• Enhanced field documentation for better clarity

Transfer object documentation

• Added comprehensive documentation for the existing Transfer object in batch records
• Documented all financial breakdown fields including gross amounts, fees, adjustments, and net funded amounts
• Created dedicated QueryBatchesTransfer type definition for better schema organization

Enhanced examples

• Updated examples to show realistic batch data with proper field values
• Added comprehensive sample responses demonstrating the full data structure
• Replaced placeholder values with actual data examples