6 October 2023

Changes between 8 September and 6 October 2023

Accounts

Fixed

On the Create account application and Create account application (outdated) endpoints, the platform now correctly validates the document_number field as required.

Updated

The Accounts API now returns the "400 - Bad request - Invalid character in the request payload" error response when the request contains invalid characters such as special characters or emojis.

Updated

On the accounts onboarding succeeded-1 event, under applicant > account, added the creationDate field.

Updated

On the accounts address endpoints, added maximum length values on the address, complementary_address, neighborhood, zip_code , city, state, and country fields.

Updated

On the Create phone endpoint, area_code is no longer a required field.

Migrations

Updated

On the Account migration started event, under the applicant object, added the company object.

Updated

On the Migrate authorizations endpoint, updated the default of update_limit to false and added the following enum list options to authorization_status.

PENDING - Authorizations from Base I, pending confirmation
PROCESSED - Base II confirmation
DROPPED - Authorization discarded if confirmation (Base II) is not received within ten days
DECLINED - Authorization denied when validation fails (response code <> 00)
CANCELED - Canceled authorization

Updated

In the Migrate accounts endpoint, the new field percentage_over_limit in the request body is now available.

Updated

In the Migrate tokens endpoint, the phase_id field is now added to the request body and is a required field. Also in the same endpoint, the following fields have been removed.

record_type
entity_type
primary_account_number_source
previous_status
wallet_provider_account_hash
decision
number_of_activation_attempts

Docs

On the Migrations overview guide, added a note that says customers should contact the implementation team for the latest version of file templates.

Docs

In the Migrate PCI cards endpoint, updated descriptions in the following fields of the request body.

service_code
pin_block
password_updated

Docs

On the Migrate on-us authorizations endpoint, added a list of examples under authorization_status_id.

Payments

Updated

On the platform-authorization-1 event, added the beneficiary_id, ledger_id, posting_date, and statement_id fields, and changed format of the posting_date field.

Updated

On the authorization-event-1 and authorization-cancellation-event-1 events, made the following updates.

Added the event_datetime field in the UTC 3339 formal that includes milliseconds.
Within authorization, added the balance_impact field.
Updated titles, summaries, and field descriptions, added links to endpoints, and reorganized the fields with the required ones at the top.

Docs

Re-added and standardized the pre-authorization-capture-1 event.

Docs

Marked the platform-authorization-1 and on-us-1 events with the [beta] tags since they are currently only utilized in the on-us authorizations functionality, which is in the beta stage prior to general release.

Docs

On the request of the Create installments payment endpoint, in the installments array of objects, marked the total_amount and principal_amount fields required.

Docs

On the Hold funds guide, made the following updates.

Corrected information about the account status and program type.
Added explanation of the skip_balance_validation field and removed this field from the Unblock held amount and Transfer held amount endpoints.

Programs

New

The new endpoints for programs export (download) and import (upload) are now available in the Programs API.

Docs

Revised the description for the program parameter ALLOW TOKENIZED TRANSACTION WITH CREATED CARD. This setting allows the customer to create a token in their digital wallet to use a physical card as long as the card has status CREATED. It permits making transactions via wallet before the physical card is activated.

Transactions

Fixed

In the result of the List transactions and Get transaction endpoints, there were typos in two fields.

The tax with type INTEREST was returned as INTERESET.
The number_of_installments field was returned as number_of_Installments.

To maintain compatibility with previous versions, the new tax type INTEREST and the new field number_of_installments have been added. Going forward, you should use the values with the correct spelling because the incorrect fields are scheduled to be deprecated.

Updated

On the transaction creation-1 and update-1 events and on the response of the Get transaction and List transactions endpoints, added the event_datetime and payment_datetime fields in that UTC 3339 format that includes milliseconds, and updated descriptions for the event_date and payment_date fields.

Data events

New

Documentation for the new JSON schema change event is now available.

Docs

Updated titles of most events according to standards.

Card network integration

Docs

The new Card network interchange fees guide is now available.

Updated

On Validation codes for authorization events, added two new denial codes: RAD - Rates API denial and HCE - HSM communication error, and updated values for the ZBU, ZBT, ZBF, ZBA, and ZBE codes.

Docs

On the Simulate authorizations endpoint, added examples for installment authorization and replacement authorization.

Statements

New

The following two new parameter codes are now available in credit liquidation.

505 - DELINQUENT_ACCOUNT_CLOSURE_LATE_TRX_DEBIT_PROCESSING_CODE
506 - DELINQUENT_ACCOUNT_CLOSURE_LATE_TRX_CREDIT_PROCESSING_CODE

Docs

The new Recurring charges guide is now available.

Docs

The API Reference documentation for some of the endpoints in the Statements API incorrectly stated that they require account tokens. The API Reference has been updated to correct this.
The List discharges endpoint does require a token endpoint, but it was not listed in Endpoints that require an account-specific token. It has been added to the document under a new section: STATEMENTS DISCHARGE TRACKING.

Corporate banking

New

The new Post a multi-leg payment endpoint is now available. This endpoint allows you to post multi-leg payments to the Pismo platform.

Fixed

The Save BCB SPB provider configuration endpoint has been updated to reflect accurate document_number string of Org’s ISPB. Also, required fields have been designated as such.

Deprecated

On the Bank accounts API, the older Register bank account, Get bank account by Pismo account, and Update bank account endpoints are now deprecated and scheduled for decommissioning on 25 March 2023.

Updated

The formerly International bank account endpoints have been updated to reflect their status’ as applicable for all regions — Get bank account and Delete bank account — and for specific regions, such as Brazil (IBAN, Brazilian bank account, and BBAN) and the UK (SCAN).

Updated

Added minimum and maximum values on the number of request and response fields on the following endpoints.

Update corporate account status
Rollback corporate account status
Get account info
Create earmark

Updated

The Create earmark, List earmarks, and Get earmark endpoints, accepting internal operations in earmark requests is now enabled. It allows you to provide tracking ID and metadata in the internal_operation object.

Updated

On the Post a payment endpoint, added a note that says if the account has any reason-based force payment restrictions, the operation will fail, and provided reasons. On the same endpoint,made the following updates.

Forced transfer: When making a forced transfer; that is, setting the debit, credit, and force_post to true, the authorization-event-1 and creation-1 events are generated with additional fields. The corporate_metadata inside metadata (authorization-event-1) or the details (creation-1) fields are updated to include.

authorization_type: Included to identify the payment type as corporate-force-transfer in the debit authorization event.
credit_tracking_id: Included in the corporate_metadata debit event to identify the credit operation tracking id.
debit_tracking_id: Included in the corporate_metadata credit event to identify the debit operation tracking id.

Earmark payment transfer: When making an earmark payment transfer (debit, credit), the events authorization-event-1 and transaction creation-1 are generated with additional fields: the corporate_metadata inside metadata (authorization-event-1) or the details (creation-1) fields are updated to include.

earmark_id: Included to identify the payment type as corporate-earmark-transfer in the consumer authorization event.
credit_tracking_id: Included in the corporate_metadata debit event to identify the credit operation tracking ID.
debit_tracking_id: Included in the corporate_metadata credit event to identify the debit operation tracking ID.

The response body returns only authorization_id from debit. The authorization_id from credit is generated asynchronously.

Updated

The value_dated_balance field is now available in the response body (200) of the following endpoints.

Updated

The following event schemas have been updated to indicate acceptable status, as well as minimum and maximum character values of these statuses.

Updated

In the account balance_change-1 and balance_history-1 events, added an object called value_dated_balance.

Updated

On the Update earmark endpoint, added internal_operation in the request body.

Updated

On the Cancel an earmark endpoint, added new error mapping and code for corporate accounts not found and removed 409 error from the response.

Docs

The new Banking reports guide is now available.

Marketplace

Updated

On the Update marketplace endpoint, the new request field external_id field is now available.