Changelog

Changes for August 18, 2025

We’ve released several updates to the API and documentation. These changes are scheduled to go live in Sandbox on August 6, 2025, and in Production on August 11, 2025.

API changes

New endpoints

• GET /Query/transfers/org/{orgId}: Retrieve a list of transfers for an organization. Use filters to limit results. This endpoint supports the same filtering capabilities as the /Query/transfers/{entry} endpoint that lists transfers for a specific paypoint.

Enhanced filtering and data

• /Query/transfers endpoints: Added support for new filter parameters:

  • transferId (in, nin, eq, ne)
  • bankAccountNumber (ct, nct, ne, eq)
  • bankRoutingNumber (ct, nct, ne, eq)
  • batchCurrency (in, nin, ne, eq)

• Enhanced BinData object: Added new fields to provide more detailed card information:

  • binCardIsRegulated: Indicates whether the card is regulated
  • binCardUseCategory: The use category of the card
  • binCardIssuerCountryCodeA3: Three-letter country code for the card issuer

These fields enhance the BinData object used in multiple response schemas, providing more context about the card used in transactions.

• /Query/Transfer: Added new fields to transfer objects:

  • batchCurrency: The currency of the batch
  • batchRecords: Number of records in the batch
  • paypointEntryName: Entry name for the paypoint
  • paypointLegalName: Legal name of the paypoint
  • paypointDbaName: DBA name of the paypoint
  • paypointLogo: Logo URL for the paypoint
  • bankAccount: Bank account information including account and routing numbers

• /Query/Batches and /Query/batchDetails response schema enhancements: Added new fields and modified some fields for enhanced batch reporting:

  • AchHolderType: ACH account holder type
  • AchSecCode: ACH SEC code
  • ChargebackId: Chargeback identifier
  • CfeeTransactions: C-fee transaction details
  • DeviceId: Device identifier
  • EntryPageid: Entry page identifier
  • FeeAmount: Fee amount
  • OrgId: Organization identifier
  • PaymentSettlementStatus: Payment settlement status
  • PayorId: Payor identifier
  • PendingFeeAmount: Pending fee amount
  • RefundId: Refund identifier
  • RetrievalId: Retrieval identifier
  • ReturnedId: Returned transaction identifier
  • splitFundingInstructions: Split funding instruction details
  • TotalAmount: Total transaction amount

Several Query endpoints: Added risk management fields to various Query endpoints, including:

• RiskFlagged
• RiskFlaggedOn
• RiskStatus
• RiskReason
• RiskAction
• RiskActionCode

Enhanced payout authorization

• /MoneyOut/authorize: Added support for storedMethodId in the payment method object. This enhancement introduces a new vault-based approach for managing ACH payment methods, allowing vendors to have multiple stored ACH accounts.

Previous behavior

Before this enhancement, ACH payment details were stored directly in the vendor object as billingData, meaning each vendor could only have one ACH payment method. The system always used that single ACH account for payments.

Example request:

1
{
2
  "entryPoint": "48acde49",
3
  "source": "api",
4
  "paymentMethod": {
5
    "method": "ach"
6
  },
7
  "paymentDetails": {
8
    "totalAmount": 150.00
9
  },
10
  "vendorData": {
11
    "vendorNumber": "ACME-12345",
12
    "billingData": {
13
      "bankName": "Wells Fargo Bank",
14
      "routingAccount": "121000248",
15
      "accountNumber": "1234567890",
16
      "typeAccount": "Checking",
17
      "bankAccountHolderName": "ACME Construction LLC"
18
    }
19
  }
20
}

New behavior

With the new enhancement, vendors can have multiple ACH payment methods stored in a vault. The storedMethodId field allows you to specify which ACH account to use for the payout. See the Payouts with saved ACH payment methods section for more details on how to use this new feature.

New PayOutReturned webhook event

We’ve add the new PayOutReturned webhook event. The PayOutReturned event triggers when a payout is returned. See PayOutReturned for more information.

Updated time format in webhook payloads

We’ve updated the transTime field in the following webhook payloads to a 24-hour format:

• RecoveredTransaction
• ReleasedTransaction
• HoldTransaction

We’ve updated the createdAt field in the following webhook payloads to a 24-hour format:

• ActivatedMerchant
• UpdatedMerchant

Transaction status descriptions in some /Query endpoint exports

We’ve added transaction status descriptions to the exports of several /Query endpoints. These descriptions provide more context about the status of payment transactions. See transaction status descriptions in Pay In statuses for a full reference.

• /Query/transactions and /Query/transactionDetails: Added TransStatusDescription field to provide a human-readable description of the transaction status.
• /Query/batchDetails and /Query/batches: Added PaymentTransStatusDescription field to provide a human-readable description of the payment transaction status.

Export functionality updates

We’ve introduced new export capabilities across Query endpoints, allowing you to export data in CSV or XLSX formats directly from the API. This replaces the Export endpoints, streamlining the process of obtaining data in a file format.

What’s changing

Instead of using separate Export endpoints, you can now add the exportFormat query parameter to existing Query endpoints:

• Supported formats: csv or xlsx
• Response type: File download (instead of JSON)

Migration example

Before (deprecated):

  GET /Export/transactions/csv/12345

After (new method):

  GET /Query/transactions/12345?exportFormat=csv

Endpoints by resource

Bills

Boarding Applications

Invoices

Batch Details

Batches

Outbound Batches

Chargebacks

Customers

Organizations

Payouts

Paypoints

Settlements

Subscriptions

Transactions

Transfers

Transfer Details

Vendors

Virtual Cards

Important notes

• The deprecated Export endpoints will continue to work but are no longer being enhanced or maintained
• All Query endpoints listed above support both csv and xlsx export formats
• When using the exportFormat parameter, the response will be a file download instead of JSON

Documentation updates

As part of an ongoing effort to better align the documentation with the API, we’ve updated several response schemas. These changes affect the documentation only—the API itself hasn’t changed in most cases.

• BinData documentation updates and corrections: Updated field descriptions for better clarity and formatting, including:

  • Improved documentation for binCardBrand, binCardCategory, and binMatchedLength
  • Type corrections for binCardIssuerCountryNumber and binMatchedLength (changed from double to string)

• Example updates: Refreshed examples across multiple endpoints to use proper schema references instead of placeholder [object Object] values.

• Payout query: The payout transaction query response had a complete restructuring with major additions. These fields were added:

  • BatchId
  • ScheduleId (In development)
  • SettlementStatus
  • IsSameDayACH (In development)
  • HasVcardTransactions (In development)
  • PayoutProgram (In development)
  • ParentOrgId Many existing field names had their casing standardized (for example: paypointDbaname → PaypointDbaname) to match what is returned by the API.