Skip to main content

Breaking change (03 September 2024) - Adding a new currency status in the buyer resource

· 3 min read

On 3rd September 2024, we are introducing a breaking change to the Buyer endpoints to enhance your ability to track the status of currency creation. This breaking change will include modifications to the HTTP 200 response when creating and updating a buyer, as well as changes to the webhook events to support buyer updates.

Effective:

  • 03 September 2024 on Sandbox
  • 24 September 2024 on Live

Summary​

API Endpoint changes​

In the HTTP 200 response of the create a buyer endpoint, the supportedCurrencies field has been restructured as an array of objects. We have added a status field to indicate the status of each supported currency created. The status field will include the following enums:

  • PENDING_KYB_APPROVAL: The buyer’s KYB process is pending approval.
  • STEPUP_LOGIN_REQUIRED: The buyer needs to perform a stepped-up login for higher authentication.
  • PENDING_CREATION: The system is awaiting the completion of the ZBA creation process.
  • ACTIVE: The ZBA has been successfully created and is ready for use.
  • UNAVAILABLE: The currency is unavailable and cannot be used.
note

The HTTP 200 response of the get buyer details have also been updated to support the supportedCurrencies field has been restructured as an array of objects and the addition of the status field to indicate the status of each supported currency created.

The update a buyer endpoint has been enhanced to allow updating the admin user's roles and the supportedCurrencies. The HTTP 201 response now includes supportedCurrencies as an array of objects, each with a status field indicating the status of each supported currency.

danger

The update a buyer endpoint requires a user with admin role and a stepped up token.

KYB information (company and adminUser information) has been removed from the update a buyer endpoint, and a new endpoint Update Buyer's KYB details has been created specifically for updating KYB.

note

We also removed the resetMobileCounter from the update a buyer endpoint which had redundant information.

Event webhook changes​

To accommodate these changes, we have updated buyer activation webhook to a Buyer Update webhook. The new webhook now includes the status of a buyer's supportedCurrency updates in its payload.

Action required​

Review and update your application logic to accommodate the changes in the supportedCurrencies field and begin capturing the associated status. This will help prevent any disruptions to your integration.

If no action is taken​

If no action is taken, your application may encounter issues when parsing the buyer resource object.

Affected webhook events:

Affected API endpoints: