3 January 2025
Changes between 6 December 2024 and 3 January 2025
Accounts
Docs
In the Overwrite customer information and Update customer information endpoints, the field descriptions have been updated to clarify if the endpoint updates the fields even if a field value isn't passed.
Client webhooks
Updated
New request and response fields have been added to the Zero balance validations webhook. The new fields support Visa’s Address Verification Service (AVS) and Account Name Inquiries (ANI) as part of name matching validations. The new fields are listed in the Request fields and Response fields tables and are also included in the Sample request code and the Sample response code provided in the Client webhooks guide.
Flex controls
Updated
In the Update account flex control endpoint, the available_limit
field has been added to limit the total available spending.
Migrations
Docs
Updated the description for the Start migration of balances endpoint to clarify that the correct balance amount to pass in the request depends on when during the statement cycle the account is being migrated.
Payments
Updated
The following updates have been made to standardize currency fields for ISO 4217.
- In the Request authorization endpoint, the
currency_code
field was updated to support both alphabetic and numeric 3-character codes. - In the Payment methods authorization created event, the
currency_num_code
field has been added and the description of thecurrency_code
field has been updated. - In the Platform authorization created event, the
account_currency_num_code
andlocal_currency_num_code
fields have been added.
Updated
In Create installments payment, the first_installment_date
field has been added to specify the date that the first installment should be posted on the invoice.
Docs
In the Cancel cash-in or cash-out and Cancel transfer endpoints, the example for the tracking_id
has been updated to distinguish it from the original_tracking_id
.
Setup
Docs
The Balances configuration guide and API have been updated for clarity and standardization.
Docs
The Platform setup - Divisions and Platform setup - Programs APIs have been updated for documentation standards, including various changes to endpoint descriptions, parameter descriptions, attributes, and other minor changes.
Transactions
Docs
In the Processing codes and transaction types and Transactions overview guides, the transaction type description has been updated.
Events
Docs
The SFTP event file configuration tutorial has been updated to indicate that a direct IP address or list of IP addresses in /32 subnet mask format must be included in the request for SFTP access.
Reports
Docs
The Scheduled reports guide has been updated to clarify that reports run on independent schedules and frequencies (not on demand).
Integrated payments
Docs
In the List bank slip receipt endpoint, the new additional_info
field has been added under the items
object in the 200 response payload. This field stores managed data that banking providers send to Pismo.
Instant payments
New
The following new endpoints are now available in the Pix management API.
- List scheduled transfers returns a list scheduled Pix transfers.
- List Pix scheduler executions returns a list of scheduled Pix transactions that have run and are complete.
Updated
In the Pix management API, the following changes have been made.
- In the Close refund endpoint, the new
INVALID_REQUEST
enum has been added to therefund_rejection_reason
field. - In the Delete key endpoint,
RFB_VIOLATION
has been added to thereason
field. - In the Create infraction report endpoint, the
contact_information
object containingphone
andemail
fields has been added.
Docs
Banking overview now includes information about STR protocol.
Transaction banking
Deprecated
The following transaction banking endpoints were deprecated and removed on 20 December 2024.
Transaction banking API
Deprecated endpoint | New endpoint |
---|---|
Post payment (v1) | Post payment (v2) |
Post multi-leg payment (v1) | Post multi-leg payment (v2) |
Get multi-payment status (v1) | Get multi-leg payment status (v2) |
Schedule payment (v1) | Schedule payment (v2) |
List scheduled payments | List scheduled payment (v2) |
Get scheduled payment by ID | Get scheduled payment by ID (v2) |
Cancel scheduled payment | Cancel scheduled payment (v2) |
Create division (v1) | Create division (v2) |
List division (v1) | List division (v2) |
Get division by code (v1) | Get division by code (v2) |
Patch division (v1) | Patch division (v2) |
Create earmark (v1) | Create earmark (v2) |
Update earmark (v1) | Update earmark (v2) |
Cancel earmark (v1) | Cancel earmark (v2) |
Create dormancy configuration (v1) | Create dormancy configuration (v2) |
Update dormancy configuration (v1) | Update dormancy configuration (v2) |
Update transaction banking account status (v1) | Update transaction banking account status (v2) |
Roll back transaction banking account status (v1) | Roll back transaction banking account status (v2) |
Updated
In the Account balance history generated event, the following new fields have been added to trigger_reason
. These new fields provide more details about future-business-dated operations than what was previously available.
FUTURE_BUSINESS_DATED_OPERATION
FUTURE_BUSINESS_DATED_OPERATION_CURRENT_DATE
Updated
The new 400 message Transfer must be sent by debit account
and examples have been added to the following endpoints. The error indicates that transfer requests cannot originate from a credit account.
Updated
In the Upload bulk file endpoint, the new 400 message Duplicate bulk file uploaded
has been added.
Updated
In the Post payment endpoint, the following 400 error examples have been added.
WPMT0005: Future dated payments only supports default debit processing code
WPMT0006: Future dated payments only supports default credit processing code
WPMT0036 : Future dated earmark payments are not allowed
WPMT0050: Payment business date cannot be earlier than earmark creation date
Updated
In the Post payment endpoint, the following error examples have been corrected.
- For
WPMT0025
, the error message used to beDebit earmark not permitted on a closed account
, and now it’s corrected toDebit not permitted on a closed account
. - For
WPMT0026
, the error message used to beCredit earmark not permitted on a closed account
, and now it’s corrected toCredit not permitted on a closed account
.
Updated
In the Post multi-leg payment endpoint, the following 400 error has been added.
WMLP0005: Validation error: one or more legs did not pass validation
Updated
In the Create earmark endpoint, the following 400 error example had been corrected.
- It used to be:
WEAM0015: release_datetime cannot be in the past
, but it is now corrected to:schedule_release_datetime cannot be in the past
.
Updated
In the List transactions endpoint, the new numberOfLatestTransactionsQuery
query parameter has been added to list latest transactions based on the date specified in the event_date
field.
Updated
Removed the following 400 error messages as they no longer apply.
- In Post payment, removed error
WEAM0021: Earmark transaction collision detected. OrgID: org_id, EarmarkID: earmark_id, TrackingID: tracking_id
. - In Post multi-leg payment, removed error
WMLP0005: Validation error: one or more legs did not pass validation
.
Updated
In the Get account balance history configuration endpoint, the new end
field has been added to previous
> cycle_config_validity
of the 200 response payload to indicate when the balance history configuration ends.
Docs
The text in the information box in Payment overview has been updated to state that “You cannot use Post multi-leg payment to transfer credit and debit leg payments to different accounts for identical amounts. For such situations, send Post payment requests instead.“ Previously, the statement said “same account“ instead of “different accounts.”
Cards
Updated
The Get non-PCI card information endpoint now requires the x-account-id
header.
Updated
The abu_enabled
field for the Create card, Reissue card, and Create noname card bulk endpoints has been deprecated. This field, indicating if the card should be enabled for Mastercard’s Automatic Billing Update service, is now enabled during setup. You can opt out of this service, if enabled, using the Update card information endpoint.
Card network integration
New
There is a new custom validation code for authorization events: Credit limit impact not found (CLF). When the authorization gets an error while trying to retrieve information from the Credit Limit Impact, the card network is notified that there is an internal error and a message is generated for this authorization. This new custom code is documented in the Validation codes for authorization events and Validation code definitions guides.
Updated
The CED (Invalid expiration date provided) response code for RuPay has been changed from 14 to 54. This update is reflected in the Authorization validations table of the Validation codes for authorization events guide and in the CVM validation table of the Rule list guide. The CVM validation description has also been updated for clarification.
Docs
The new Authorization discard process section has been added to the Authorization events guide. This new section details the purchaser cancellation process and documents the authorization discard timing when a purchase does not receive confirmation via Base II and does not receive a cancellation (online or via Base II).
Docs
The Validation code definitions guide has been updated to display the codes definitions in alphabetical order for ease of use and many definitions have been updated for clarity.
Disputes
Updated
There are new fields you can update with the Update dispute endpoint: disputed_amount
, comment
, and first_installment_amount
.
Statements
Updated
The cycle
field has been added to the 200 response for Get scheduled charge and List scheduled charges.
Docs
The endpoint description for Get program future calendars has been updated to explain the use of the query parameters showCustomCalendars
, divisionId
, and programCalendarStrategyId
.
Docs
The description of the Update multivalue program parameter values endpoint has been updated.
Docs
Some inaccuracies in Calculating interest accruals have been corrected.
Docs
In the request payload of Create payment agreement, the payment_datetime
field was incorrectly documented as a property of the installments array. It's now documented as a separate parameter.
Sellers
New
The new List advancement requests settled endpoint is now available in the new “Settlements” subsection under “Seller management - Sellers”.
Updated
The title of “Seller management - Settlements” has been changed to "Seller management - Sellers" API and the URLs for all the endpoints in this section have been changed as follows.
- For Block merchants for settlement, the URL changed from
POST /settlements/actions/block
to
POST /sellers/v1/settlements/actions/block
- For Unblock merchants for settlement, the URL changed from
POST /settlements/actions/unblock
to
POST /sellers/v1/settlements/actions/unblock
- For Get blocked merchants, the URL changed from
GET /settlements/merchants/blocked
to
GET /sellers/v1/settlements/merchants/blocked
- For Run settlement, the URL changed from
POST /settlements/actions/run
to
POST /sellers/v1/settlements/actions/run
Deprecated
The Create creditor endpoint is now deprecated and scheduled for removal on 30 June 2025.
Pismo Control Center
Updated
The new "Device Registered" condition is now available in Flex Controls within the Control Center. This enables you to create a set of controls to mitigate potential fraudulent actions by individuals using non-registered devices.
Postman
Docs
The Testing Pismo API endpoints with Postman guide has been updated for clarity and to adhere to the Pismo style guide.