Shipment Invoicing and Orders APIs to provide new payment data for the Brazil marketplace
August 19th, 2025 by JackE_Amazon
Starting August 28, 2025, the following operations will return new payment fields:
getShipmentDetails
will return new payment fields for new Seller Flex (FBA Onsite) shipments.getOrders
will return new payment fields for new Self Ship (MFN) and Easy Ship (DBA) orders.
Shipment Invoicing API (Seller Flex shipments)
The getShipmentDetails
response will include a new Payments
array that contains the following payment information for each transaction in the array:
Property | Type | Description |
---|---|---|
PaymentMethod | string | Payment method used to make the payment. Possible values: CreditCard , Pix , Boleto , Rewards , Other . |
AcquirerId | string | Government ID of the payment acquirer (CNPJ format) who authorized the payment. Required only for credit card (CreditCard ) and Pix payments. |
CardBrand | string | Credit card brand used. Required only for credit card payments (CreditCard ). |
PaymentValue | object | Amount paid in this specific payment transaction. Contains the following properties: CurrencyCode , Amount |
AuthorizationCode | string | A unique identifier provided by the acquirer for the payment authorization transaction. Required only for credit card (CreditCard ) and Pix payments. |
Example
{
"payload": {
"ShipmentDetail": {
"PurchaseDate": "2025-08-01T14:44:38Z",
"WarehouseId": "XXXX",
"AmazonOrderId": "701-0000000-0000000",
"AmazonShipmentId": "DrLqQwqvb",
"Payments": [
{
"PaymentMethod": "CreditCard",
"AcquirerId": "XX.XXX.XXX/0001-ZZ",
"CardBrand": "Visa",
"PaymentValue": {
"CurrencyCode": "BRL",
"Amount": "100"
},
"AuthorizationCode": "123456"
}
]
// ... all existing fields remain unchanged
}
}
}
Orders API (Self Ship and Easy Ship orders)
In the response to the getOrders
operation, the existing PaymentExecutionDetail
array in each entry of the Orders
array will have the following additional fields in the Brazil marketplace:
Property | Type | Description |
---|---|---|
AcquirerId | string | Government ID of the payment acquirer (CNPJ format) who authorized the payment. Required only for credit card (CreditCard ) and Pix payments. |
CardBrand | string | Credit card brand used. Required only for credit card payments (CreditCard ). |
AuthorizationCode | string | A unique identifier provided by the acquirer for the payment authorization transaction. Required only for credit card (CreditCard ) and Pix payments. |
Example
{
"payload": {
"AmazonOrderId": "701-0000000-0000000",
"MarketplaceId": "A2Q3Y263D00KWC",
"PaymentExecutionDetail": [
{
"Payment": {
"CurrencyCode": "BRL",
"Amount": "20.00"
},
"PaymentMethod": "Pix",
"AcquirerId": "XX.XXX.XXX/0001-ZZ",
"AuthorizationCode": "123456"
},
{
"Payment": {
"CurrencyCode": "BRL",
"Amount": "80.00"
},
"PaymentMethod": "CreditCard",
"AcquirerId": "YY.YYY.YYY/0001-AA",
"CardBrand": "Visa",
"AuthorizationCode": "789012"
}
]
// ... all existing fields remain unchanged
}
}
Which marketplaces are affected?
This change affects the Brazil marketplace.
Who is affected?
This change affects developers that do the following:
- Use the Shipment Invoicing API or Orders API.
- Retrieve payment details for orders to issue invoices that comply with Brazilian tax authorities (SEFAZ) regulations.
What action is required?
If you have an application that is affected by this update, you must update your application to accept these new fields by August 28, 2025.