Changelog

New fields in boarding applications and templates

We’ve added several new fields to the boarding applications and templates APIs.

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.