Update: Orders API v0 returns Pix, Boleto, and rewards-based payment method details
In early 2024 Amazon refreshed Orders API v0, adding explicit paymentMethod values “PIX”, “BOLETO” and “REWARDS” to the paymentMethodDetails object (replacing the generic “Other”). Sellers have a 30‑day window to modify their parsing logic, otherwise downstream reporting and fee calculations may miss these orders.
Overview
Amazon refreshed the Orders API v0 in early 2024, adding distinct identifiers for Pix, Boleto, and rewards‑based payments in the paymentMethodDetails field. The change replaces the previous generic “Other” label, giving sellers clearer insight into Brazilian and rewards transactions. Sellers who depend on order‑level data for reconciliation, reporting, or support must update their integrations to capture the new values.
Key Points
- New payment identifiers — Orders that previously appeared as “Other” now return “PIX”, “BOLETO”, or “REWARDS” in the paymentMethodDetails object, allowing direct classification.
- Brazil‑centric impact — The update mainly affects shipments to Brazil, where Pix and Boleto together account for the majority of online payments, so Brazilian‑focused sellers will see the most immediate benefit.
- Rewards clarity — Purchases that use Amazon Rewards points, either partially or fully, are now flagged with the REWARDS code, separating them from cash‑based sales for the first time.
- Backward‑compatibility note — Existing API endpoints remain functional, but any logic that treats “Other” as a catch‑all must be expanded to recognize the three new strings, or else it will miss or misclassify orders.
- Reporting enhancement — With explicit payment codes, sellers can segment dashboards, calculate payment‑method fees, and prepare tax filings with greater precision, especially for Brazilian tax regimes that treat Pix and Boleto differently.
- Implementation window — Amazon advises updating parsing logic within 30 days of the rollout; delays may cause mismatches between source data and downstream analytics or invoicing systems.
How the Updated Orders API v0 Works
-
Request the order — A seller issues
GET /orders/v0/orders/{orderId}; the response now contains apaymentMethodDetailsobject that includes apaymentMethodkey with a concrete value.- Example: A buyer in São Paulo completes checkout using Pix; the API response includes instead of the prior placeholder.
Analysis & Recommendations
Why This Matters
Brazilian transactions, which dominate Amazon Brazil sales, now surface with accurate codes, enabling correct fee application (1.5% Pix, 2.0% Boleto, 0% Rewards) and tax filing. If integrations keep treating "Other" as catch‑all, dashboards and invoicing will misclassify orders.
Key Takeaways
- Orders API v0 now returns paymentMethodDetails.paymentMethod = "PIX", "BOLETO" or "REWARDS" instead of "Other".
- The change mainly impacts shipments to Brazil, where Pix and Boleto account for the bulk of payments.
- Sellers must update their integration within 30 days of the rollout to avoid misclassification.
- Fee structures can now be applied per method: 1.5% for Pix, 2.0% for Boleto, and 0% for Rewards.
Recommended Actions
- →In Seller Central > Developer Console, edit your SP‑API parser to replace any `if (paymentMethod.equals("Other"))` checks with a switch handling "P...
- →Create sandbox orders for each payment type and verify the API response includes the new identifiers.
- →Set up a CloudWatch alarm or Lambda that scans recent orders; if `paymentMethod == "Other"` exceeds 0.5%, trigger an alert for manual review.
Comments
Join the discussion
Log in or create an account to share your thoughts on this update.
No comments yet. Be the first to share your thoughts!