Payments v2 – deprecated

WARNING: This API endpoint is Deprecated.

Do not build any new functionality based on this endpoint.

It has been replaced by the Invoice Endpoints.

 

Get payments

Retrieve all payments for a specific month. Payments are sorted by date, ascending.

GET /services/rest/payments/v2/:yyyymm

Parameters

Name Type Description
period integer the format is year + the two digits representing the month. Please note that the period must always be 6 characters long. Please use a leading zero for months of only 1 digit. The example below requests all payments for february 2016

 

GET /services/rest/payments/v2/201602

Example response

Status: 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Payments xmlns="https://plazaapi.bol.com/services/xsd/v2/plazaapi.xsd">
 <Payment>
 <CreditInvoiceNumber></CreditInvoiceNumber>
 <DateTimePayment></DateTimePayment>
 <PaymentAmount></PaymentAmount>
 <PaymentVAT></PaymentVAT>
 <ShippingLabelCosts></ShippingLabelCosts>
 <ShippingLabelVAT></ShippingLabelVAT>
 <PaymentShipments>
 <PaymentShipment>
 <ShipmentId></ShipmentId>
 <OrderId></OrderId>
 <PaymentShipmentAmount></PaymentShipmentAmount>
 <PaymentShipmentVAT></PaymentShipmentVAT>
 <PaymentStatus>FINAL</PaymentStatus>
 <ShipmentDate></ShipmentDate>
 <PaymentShipmentItems>
 <PaymentShipmentItem>
 <OrderItemId></OrderItemId>
 <EAN></EAN>
 <OfferReference></OfferReference>
 <Quantity></Quantity>
 <OfferPrice></OfferPrice>
 <ShippingContribution></ShippingContribution>
 <TransactionFee></TransactionFee>
 <TotalAmount></TotalAmount>
 <ShipmentStatus></ShipmentStatus>
 </PaymentShipmentItem>
 </PaymentShipmentItems>
 </PaymentShipment>
 </PaymentShipments>
 </Payment>
</Payments>