HomeDocumentationCode SamplesAPI ReferenceAnnouncementsModelsRelease NotesFAQGitHubVideos
Developer HubAPI StatusSupport
Announcements
Developer HubAPI StatusSupport

Update: Orders API v0 returns Pix, Boleto, and rewards-based payment method details

The paymentMethodDetails field of the Orders API v0 now returns Pix, Boleto, and Rewards values to help you identify payment methods in your orders information. Previously, these values were returned as Other. This enables the API users to properly identify those payment methods in their orders information.

The new payment method values return the following strings:

  • Pix - For the Brazilian Pix payment method.
  • Boleto - For the Brazilian Boleto payment method.
  • Rewards - For a points-based or rewards-based payment method.

Which marketplaces are affected?

  • North and South American marketplaces: CA, US, MX, BR

  • European marketplaces: ES, UK, FR, BE, NL, DE, IT, SE, ZA, PL, EG, TR, SA, AE, IN

  • Asian marketplaces starting: SG, AU, JP

  • Rewards applies to all marketplaces.

  • Pix and Boleto applies to the Brazil marketplace.

Who is affected?

Developers with application that use the Orders API v0 and rely on the paymentMethodDetails field to retrieve Pix, Boleto, or Rewards paid orders are affected by this change.

What action is required?

If you have an application that is affected by this change, you must update your application output validation to acknowledge those payment methods as different from Other when updating the paymentMethodDetails field.