Changelog

New signer fields for boarding apps

We’ve added new fields to the signer object in the boarding apps. These fields are designed to help you better manage and track your signers during the onboarding process.

The new fields include:

• pciAttestation: A boolean indicating whether the signer has completed the PCI attestation.
• attestationDate: The date when the PCI attestation was completed.
• signDate: The date when the signer signed the agreement.

Documentation updates

As part of an ongoing effort to better align the documentation with the API, we’ve updated several API references. These changes affect the documentation only. The API itself hasn’t changed.

GET /Query/invoices/ endpoint

We’ve updated response schema and examples.

• Added missing fields to the schema:
  • ParentOrgId
  • pageIdentifier
• Reordered the fields in the example and schema to accurately reflect what’s returned by the API.

GET /Invoice/{idInvoice} endpoint

We’ve updated response schema and examples.

• Reordered the fields in the example and schema to accurately reflect what’s returned by the API.
• Updated field casing to accurately reflect what’s returned by the API:
  • customer → Customer
  • paypointLegalname → PaypointLegalname
  • paypointDbaname → PaypointDbaname
  • paypointEntryname → PaypointEntryname
  • parentOrgName → ParentOrgName
  • documentsRef → DocumentsRef

New discount field for payouts

We’ve added a new discount field to the /MoneyOut/authorize endpoint in the API. This field represents any vendor discounts applied to the payout. This field is optional, and is returned in payout transaction detail and query responses.

New field in the bankData object

We’ve added the accountId field to the bankData object. This field lets you add your own internal identifier for a bank account anywhere the bankData object is used. The accountId field accepts a string of up to 64 characters.

New payout status and summary fields

The response for GET Query/payouts/{entry}/{orgId} endpoint now includes two new Summary fields: totalOnHold and totalOnHoldAmount. These fields help understand how many transactions are on hold, and the total amount of the held payout transactions. We’ve also added a new payout status option with “Status”:4 corresponding to “PaymentStatus”: “OnHold”.

New webhooks for virtual cards

Added new webhook notifications for virtual cards:

• CardCreated: triggered when a virtual card is created
• CardActivated: triggered when a virtual card is activated
• CardDeactivated: triggered when a virtual card is deactivated
• CardExpired: triggered when a virtual card has expired
• CardExpiring: triggered when a virtual card is about to expire
• CardLimitUpdated: triggered when a virtual card’s limit is updated

New subscription notifications

We added the following new notifications for subscription events:

• SubscriptionCreated
• SubscriptionCanceled
• SubscriptionCompleted
• SubscriptionUpdated

See Notifications and Reports Overview for more information.

New fields in boarding applications and templates

signDate field in boarding applications

We added a new field called signDate to the signerData object in boarding application endpoints. This field represents the date when the signer signed the application. The field accepts a date in YYYY-MM-DD or MM-DD-YYYY format. The signDate field is optional.

additionalData object in boarding templates and applications

We’ve added a new additionalData object to some objects in the boarding applications and templates APIs. You can use this object to store custom information related to the merchant’s business. The additionalData object is optional and can contain any key-value pairs that you want to include in the boarding application or template.

For example:

1
{
2
  "additionalData": {
3
    "customField1": "value1",
4
    "customField2": "value2"
5
  }
6
}

The additionalData object is available for the contacts, ownership, and signer objects and the general business information on /Templates and /Boarding endpoints.

New fields in webhook payloads

We added the externalPaypointID, Method, and entryPoint fields to the webhook payloads for these events:

• ApprovedPayment
• AuthorizedPayment
• DeclinedPayment
• FundedPayment
• OriginatedPayment
• RefundedPayment
• RecoveredTransaction
• SettledPayment
• HoldTransaction
• ReleasedTransaction

Change programId field to issuerNetworkSettingsId in boarding endpoints

We changed the programId field to issuerNetworkSettingsId in the boarding endpoints. This field represents the ID of the issuer network settings associated with a payout service. This change was made to better reflect the purpose of the field and to improve consistency across our APIs.

New endpoint for downloading chargeback attachments

We added the GET /ChargeBacks/getChargebackAttachments/{Id}/{fileName} endpoint. This endpoint allows you to download chargeback attachments, such as PDFs or images, associated with a chargeback record. The Id parameter is the ID of the chargeback record, and the fileName parameter is the name of the file you want to download.

New query parameters for export endpoints

• Added the limitRecord query parameter to all export endpoints. This parameter limits the number of records to return for the query. The maximum is 30,000 records. When you don’t include this parameter, the API returns up to 25,000 records.

• Added the fromRecord query parameter to all export endpoints. This parameter specifies the record number to start the export from. The default is 0.

You can use these query parameters together to paginate through large exports. For example, to get the first 10,000 records of an export, you would use limitRecord=10000&fromRecord=0. To get the next 10,000 records, you would use limitRecord=10000&fromRecord=10000.

New API fields

We’ve added several new fields to several endpoints.

• Added the AchSecCode field to responses for the GET Query/transactions and GET MoneyIn/details/{transId} operations. SEC code is a three letter code that describes how an ACH payment was authorized. The Query/transactions endpoints also support filtering by AchSecCode and supports these operators: ct, nct, in, nin, eq, and ne.
• Added a field that specifies what whether an accountholder is a person or a business to several request and response bodies. The field supports these values: personal and business.
• Added the achHolderType field to the request bodies for the POST TokenStorage/add, POST Subscription/add, POST TokenStorage/update, and POST MoneyIn/getpaid endpoints.
• Added AchHolderType field to the responses for the GET TokenStorage/{methodId}, GET Query/transactions and GET MoneyIn/details/{transId} endpoints.

Improved error message for transaction amount limits

We updated an error message to make it easier to understand. An error for a transaction amount outside of the maximum and minimum limits of a paypoint will now display the message:

“Transaction amount is outside the minimum and maximum limit of the paypoint.”

instead of:

“No tier is available for the amount, mode 0 or 2.”

API updates

We’ve released several enhancements and bug fixes to our API. Here are the highlights:

Pay In

• Added the ability to skip a subscription payment by setting totalAmount to zero. See Pause a subscription or skip a payment for more details.

• Added the expectedProcessingDateTime field to the responses for these endpoints:

  • GET /MoneyIn/refund/{transId}/{amount}
  • GET /MoneyIn/reverse/{transId}/{amount}
  • POST /MoneyIn/refund/{transId}

  When a paypoint has Enhanced Refund Flow enabled, the expectedProcessingDateTime field shows the date and time that a queued refund is expected to be processed.

Pay Out

Added the parentOrgId filter with (eq, neq, in, nin) operators to these endpoints:

• Query/batchesOut/{entry}
• Query/batchesOut/org/{orgId}
• Query/payouts/{entry}/{orgId}
• Query/payouts/org/{orgId}
• Query/bills/{entry}
• Query/bills/{entry}/org/{orgId}
• Query/vendors/{entry}
• Query/vendors/org/{orgId}

Pay Ops

• All instances of EIN values returned in API responses are now masked.
• Added a UpdatedMerchant webhook notification for paypoint updates. You can now get a notification when a paypoint’s address, banking information, or funding configuration is updated. See Webhook Notification Response Reference for the webhook payload.
• Added the ReplyBy field to responses from the Query/chargebacks endpoint. The ReplyBy field is the deadline by which a merchant must respond to a dispute. By default, this field is exactly 10 days after the CreatedAt timestamp, in UTC.
• Added the replyDate filter to the Query/chargebacks endpoint which allows filtering disputes by deadline. replyDate has the following conditions: (gt, ge, lt, le, eq, ne). See the Filters and Conditions Reference for more information.