Changelog

This changelog provides an overview of the recent changes made to the Payabli APIs.
July 10, 2025

Documentation updates for July 10, 2025

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.

VendorData response object changes

We’ve updated the VendorData object that’s returned in some responses to change AdditionalData to additionalData to align with what’s returned by the API.

Statistics APIs response schema updates

We’ve overhauled all Statistics APIs response schemas to align with what’s returned by the API.

Webhook payload schema updates

We’ve overhauled all webhook payload schemas to align with what’s returned by the API. See the updated payloads in Webhook notification response reference.

Global changes

The following changes apply to webhook payloads for all events except transfer events:

  • Renamed the externalPaypointID field to ExternalPaypointId.
  • Renamed the entryPoint field to EntryPoint.

Payment events

We’ve updated the webhook payloads for payment events.

WalletType

Added the WalletType field to the following webhook payloads:

  • ApprovedPayment
  • AuthorizedPayment
  • DeclinedPayment
  • VoidedPayment
  • RefundedPayment
  • OriginatedPayment
  • SettledPayment
  • ReceivedChargeBack

For response bodies with a Method value of wallet, the WalletType field will either have a value of apple_pay or google_pay. For response bodies with a Method value that isn’t wallet, the WalletType field will have a value of null.

transDate

Added the transDate field to the following webhook payloads:

  • RecoveredTransaction
  • HoldTransaction
  • ReleasedTransaction

The transDate field contains the date of the transaction in MM/DD/YYYY format.

AccountType

Added the AccountType field to the AuthorizedPayment webhook payload. If the transaction is an ACH transfer, the AccountType field will contain the type of bank account used for the transaction. If the transaction is a card payment, the AccountType field will contain the brand of the card used for the transaction.

Subscription events

We’ve updated the webhook payloads for subscription events.

Changes

Added the Changes field to all subscription events. The Changes field contains the details of the subscription modifications. For SubscriptionUpdated, the Changes field will contain the list of modified fields in the subscription, such as "EndDate, Frequency, TotalAmount". For SubscriptionCreated, SubscriptionUpdated, and SubscriptionDeleted, the Changes field will contain the value "Created", "Updated", or "Deleted", respectively.

Billing events

We’ve updated the webhook payloads for bill and payout events.

CustomerName

Added the CustomerName field to webhook payloads for billing events. The CustomerName field contains the name of the customer being billed.

TransId

Added the TransId field to webhook payloads for billing events. The TransId field contains the ID of the transaction in the bill.

CustomerId

Changed the CustomerId field to contain the numeric identifier for the customer.

Transfer events

We’ve updated the webhook payloads for transfer events.

AvailableBalance

Added the AvailableBalance field to the TransferBalanceUnavailable webhook payload. The AvailableBalance field contains the available balance of the account.

Difference

Added the Difference field to the TransferBalanceUnavailable webhook payload. The Difference field contains the difference between the requested amount and the available balance.

AdjustedAmount

Added the AdjustedAmount field to the TransferAdjusted webhook payload. The AdjustedAmount field contains the adjusted amount of the transfer.

Fraud alert events

We’ve updated the webhook payloads for fraud alert events.

LastFourDigitsOfAccountNumber

Added the LastFourDigitsOfAccountNumber field to fraud alert webhook payloads. The LastFourDigitsOfAccountNumber field contains the last four digits of the account number of the fraud alert.

CardDeclineReason

Added the CardDeclineReason field to fraud alert webhook payloads. The CardDeclineReason field contains the reason why the card transaction was declined.

Application events

We’ve updated the webhook payloads for application events.

PolicyId

Added the PolicyId field to all webhook payloads for boarding applications. The PolicyId field contains the identifier for the policy of the application.

ApplicationToken

Added the ApplicationToken field to all webhook payloads for boarding applications. The ApplicationToken field contains the unique token for the application.

ExternalPaypointId

Added the ExternalPaypointId field to all webhook payloads for boarding applications. The ExternalPaypointId field contains the identifier for the paypoint of the application.

Merchant events

We’ve updated the webhook payloads for merchant events.

Service

Added the Service field to the ActivatedMerchant and UpdatedMerchant webhook payloads. The Service field contains the service type of the merchant.

ProcessorId

Added the ProcessorId field to the ActivatedMerchant and UpdatedMerchant webhook payloads. The ProcessorId field contains the identifier for the payment processor.

AccountId

Added the AccountId field to the ActivatedMerchant and UpdatedMerchant webhook payloads. The AccountId field contains the account identifier for the merchant.

AppID

Added the AppID field to the UpdatedMerchant webhook payload. The AppID field contains the identifier for the boarding application of the merchant.