8 September 2023

Changes between 4 August and 8 September 2023

Accounts

Docs

The accounts documentation has been standardized and updated in the following ways.

Removed deprecated account limits endpoints that have been replaced by List account limits and Update account limits.
Changed the name of endpoint from "Create account application (legacy)" to Create account application (outdated) .
On the response of the List account customers endpoint, corrected the customer_id field name to be id and added the is_active field.
On the Account status guide, added a note with guidance on how to close an account on the Pismo platform.
On the Create or update account guide, added the Update account section.

Flexible transaction controls

Docs

The flex controls documentation has been updated in the following ways.

On the Endpoints that require an account-specific token reference, added "Balances and limits" endpoints and removed deprecated endpoints under "Ledger".
On the Flexible transaction controls guide, added a note about enabling the Send rules authorization program parameter and clarified the description for the spending_limit cumulative control condition.
On the Program parameters reference, updated description for the Send rules authorization parameter.

Migrations

Updated

On the Migrate cards endpoint, the enum option multiple under mode was removed and replaced by combo.

Payments

Fixed

The descriptor and description fields on all payments endpoints are now validated to remove special characters and emojis.

Updated

The payments endpoints have been updated in the following ways.

The new skip_balance_validation field is now available on the following hold funds endpoints: Block amount, Unblock held amount, and Transfer held amount.
The maximum length of the tracking_id field has been increased to 65 characters on the Cancel transfer endpoint and to 50 characters on the rest of the Payments endpoints. The maximum length of the original_tracking_id has been updated accordingly.

Docs

The new Authorization validation rules for platform operations [beta] guide contains the full list of authorization rules used by the Pismo platform to validate requests. These rules are currently utilized in the on-us authorizations functionality, which is in the beta stage prior to general release.

Docs

On the Create installments payment endpoint, marked the account_id, charging_amount, and processing_code fields as required.

Security

New

The new Third party authentication with OpenID guide introduces a new feature that allows you to give limited access to the Pismo API to a third party. Before, you could give access to a third party, but the third party would have the same access as you, which was a security concern.

New

To improve security for all Pismo web applications, web browser sessions no longer remain active indefinitely. After 20 minutes of inactivity, users will be redirected to the Pismo login screen to reauthenticate.

Transactions

Updated

On the error responses of all transactions endpoints, added the code and message fields.

Docs

Documented responses and response examples on all transactions endpoints and added the missing pageSize query parameter on the List transaction types endpoint.

Accounting

Updated

The Accounting events report files now include two new fields: AuthorizationDate and InstallmentNumber.

Events

Docs

The minimum and maximum field values have been updated on the account balance_history-1 event and on the following audit events.

Corporate banking: account_spending_limit_created-1, account_spending_limit_updated-1
Flex controls: evaluation_requested-1, evaluation_rollback_requested-1, template_created-1, template_updated-1

Docs

The new guide Depositary data events lists data events for the Credit receivables API.

Card network integration

New

The new 3DS authentication API with the Send authentication info endpoint enables 3rd-party 3DS/ACS validators for authentication in card-not-present transactions. The other HST API endpoints are for a specific vendor.

Updated

On the Simulate authorization endpoint, the new anti_fraud_url field allows you to test your full balance or zero balance anti-fraud webhook.

Docs

The new Full balance credit program guide is now available.

Disputes

Updated

The following updates have been added specifically for the ELO card network, which allows you to create a dispute for the airport tax.

On the dispute_installment_creation-1 and the dispute_installment_status_change-1 events, added the new category field with two possible values: INSTALLMENT and AIRPORT_TAX.
On the Create dispute endpoint, added the airport_tax, airport_tax_partial, and airport_tax_amount fields.

Statements

New

The new Transactions shift API is now available. For more information, see the Transaction shifts guide.

New

The new Credit liquidation API enables you to manage closure of delinquent accounts. It contains the following endpoints.

For more information, see the Credit liquidation guide.

New

The new Recurring charges API enables you to set up recurring charge plans for accounts.

Updated

On the List account accruals V3 endpoint, added the includeNegative field.

Deprecated

The Get program due dates endpoint in the Orgs API has been deprecated and replaced by the List program due dates endpoint in the Statements API.

Docs

Changed the title of “Credit card refinancing overview” to Credit card refinancing.

Asset management

Docs

Added missing reason body parameter to the Block/unblock asset endpoint.

Credit receivables

New

The new Credit receivables API is now available. A receivable represents money expected to be collected from an entity (debtor) who has purchased products or services, but has not yet paid for them in full. The lender, the person or entity owed the money, can sell this debt to a new owner, who may package it as part of another financial instrument, in much the same way a mortgage is sold to become part of a mortgage-backed security. This API allows you to register a receivable with B3 - a major financial infrastructure company in Brazil - and assign it to a new owner.

Corporate banking

New

The new Update earmark endpoint and the following new dormancy endpoints are now available.

Updated

The Create earmark endpoint now allows you to create a force earmark by setting the force_post field to true.

Updated

The Post a payment endpoint includes the following updates.

The tracking_id field is marked required.
The soft_descriptor field is no longer a required field.
The metadata field is updated with the inclusion of the corporate_metadata that contains external_account_id and earmark_id.
The payment_datetime field now indicates that you can backdate payments to up to seven days, but postdating payments is not allowed.

Updated

On the Post a payment and Schedule payment endpoints, the metadata field is updated with the inclusion of the corporate_metadata that contains the following fields.

credit_external_account_id is included in the metadata field when it's provided in the credit leg.
debit_external_account_id and earmark_id is included in the metadata field when it's provided in the debit leg.

Updated

On the Update corporate account status endpoint, the new function to validate status is now active. When you send an empty status field, the platform now returns an invalid status message with an error code “WCAC0005”.

Updated

On the Create earmark, Update earmark, and Cancel an earmark endpoints, added a note that mentions that the authorization-event-1 and transaction creation-1 events now include corporate_metadata in the metadata and details fields, respectively. The corporate_metadata field includes the following fields.

debit_external_account_id
earmark_id

Merchants

New

The following new merchants endpoints are now available.

Updated

On the Create merchant and Create creditor endpoints, updated the descriptions of the advancement_fee, discount_rate, and maximum_advancement_percentage fields to indicate that if no value is provided for these fields, the default values will be used.

Docs

Made style changes and renamed the guide to How merchant settlements are processed.

Changelog redesign

Docs

In the ongoing effort to improve content presentation of the developers portal, the changelog has been redesigned for better usability. The categories are now aligned to match Pismo product areas and the changes are categorized by their types (breaking, new, fixed, updated, deprecated, and docs).

Deprecation strategy

Docs

The new Deprecation schedule lists the endpoints currently in the sunset phase and scheduled for deprecation. The schedule provides detailed information about the deprecated endpoints and which endpoints replace them, if applicable.

The following new guides provide additional details about deprecation of the old endpoints and migration strategy to the new endpoints.

Docs

For clarity, APIs that are being maintained in parallel with a newer (recommended) version are now called “outdated” rather than “legacy”. The following pages have been updated accordingly.