Payment Endpoint Enhancements

Overview

A variety of minor enhancements are being made to our payment endpoints to help improve payment routing, reduce payment failures and provide additional clarity when integrating.

Version Impacted: V2.0

Date Effective: 2nd of August 2024

Impacted Endpoints:

• Payment Addresses
• Recipients
• Payouts
• Transfers

Summary of changes

• Made clientAddressName optional in paymentAddresses
• Added more helper text to the recipients endpoint to assist in understanding which fields are conditionally mandatory/optional
• Simplified the transfer endpoint by removing unnecessary fields
• Added some additional fields to the response for payments such as payoutType and paymentDate
• Added the ability to add an externalReference to a paymentAddress

📘

Got Questions?

Got questions or concerns about this change? Head over to our Discussion Board and leave us a note.