Sales API (1.0)

Download OpenAPI specification:Download

Sales reporting API for accounting partners

Merchant Sales

Get sales events for a ledger

Returns paginated sales events (captures and refunds) for the specified ledger. Use the cursor value to fetch subsequent pages.

path Parameters

ledgerId

required

string

Ledger ID provided by the Report API Get ledgers endpoint

query Parameters

cursor	string Pagination cursor from a previous response
pageSize	integer <int32> [ 1 .. 1000 ] Default: 100 Number of items per page (default: 100, max: 1000)

Responses

Response samples

200

Content type

application/json

{"items": [{"entryType": "capture",
"time": "2019-08-24T14:15:22Z",
"pspReference": "string",
"reference": "string",
"currency": "string",
"paymentType": "CARD",
"amounts": {"gross": 0,
"net": 0,
"vat": 0
},
"lines": [{"lineId": "string",
"name": "string",
"quantity": 0,
"unitPriceGross": 0,
"unitPriceNet": 0,
"discountTotal": 0,
"lineTotalGross": 0,
"lineTotalNet": 0,
"vatRate": 0,
"vatAmount": 0,
"category": "string"
}
],
"customer": {"email": "string",
"phone": "string",
"name": "string"
},
"classification": {"solution": "VARIABLE_AMOUNT",
"salesCategory": "string"
},
"completeness": {"hasLineItems": true,
"hasVatBreakdown": true,
"hasCustomerIdentity": true
}
}
],
"cursor": "string",
"hasMore": true
}

Get sales events for a ledger on a specific date

Returns paginated sales events (captures and refunds) for the specified ledger filtered by date.

path Parameters

ledgerId required	string Ledger ID provided by the Report API Get ledgers endpoint
ledgerDate required	string <date> Date to filter events by (YYYY-MM-DD)

query Parameters

cursor	string Pagination cursor from a previous response
pageSize	integer <int32> [ 1 .. 1000 ] Default: 100 Number of items per page (default: 100, max: 1000)

Responses

Response samples

200

Content type

application/json

{"items": [{"entryType": "capture",
"time": "2019-08-24T14:15:22Z",
"pspReference": "string",
"reference": "string",
"currency": "string",
"paymentType": "CARD",
"amounts": {"gross": 0,
"net": 0,
"vat": 0
},
"lines": [{"lineId": "string",
"name": "string",
"quantity": 0,
"unitPriceGross": 0,
"unitPriceNet": 0,
"discountTotal": 0,
"lineTotalGross": 0,
"lineTotalNet": 0,
"vatRate": 0,
"vatAmount": 0,
"category": "string"
}
],
"customer": {"email": "string",
"phone": "string",
"name": "string"
},
"classification": {"solution": "VARIABLE_AMOUNT",
"salesCategory": "string"
},
"completeness": {"hasLineItems": true,
"hasVatBreakdown": true,
"hasCustomerIdentity": true
}
}
],
"cursor": "string",
"hasMore": true
}

Get sales events by merchant reference

Returns sales events for the specified ledger matching the given merchant reference.

path Parameters

ledgerId required	string Ledger ID provided by the Report API Get ledgers endpoint
reference required	string The merchant's order reference

Responses

Response samples

200

Content type

application/json

{"items": [{"entryType": "capture",
"time": "2019-08-24T14:15:22Z",
"pspReference": "string",
"reference": "string",
"currency": "string",
"paymentType": "CARD",
"amounts": {"gross": 0,
"net": 0,
"vat": 0
},
"lines": [{"lineId": "string",
"name": "string",
"quantity": 0,
"unitPriceGross": 0,
"unitPriceNet": 0,
"discountTotal": 0,
"lineTotalGross": 0,
"lineTotalNet": 0,
"vatRate": 0,
"vatAmount": 0,
"category": "string"
}
],
"customer": {"email": "string",
"phone": "string",
"name": "string"
},
"classification": {"solution": "VARIABLE_AMOUNT",
"salesCategory": "string"
},
"completeness": {"hasLineItems": true,
"hasVatBreakdown": true,
"hasCustomerIdentity": true
}
}
],
"cursor": "string",
"hasMore": true
}

Get sales events by PSP reference

Returns sales events for the specified ledger matching the given PSP reference.

path Parameters

ledgerId required	string Ledger ID provided by the Report API Get ledgers endpoint
pspReference required	string Payment service provider reference

Responses

Response samples

200

Content type

application/json

{"items": [{"entryType": "capture",
"time": "2019-08-24T14:15:22Z",
"pspReference": "string",
"reference": "string",
"currency": "string",
"paymentType": "CARD",
"amounts": {"gross": 0,
"net": 0,
"vat": 0
},
"lines": [{"lineId": "string",
"name": "string",
"quantity": 0,
"unitPriceGross": 0,
"unitPriceNet": 0,
"discountTotal": 0,
"lineTotalGross": 0,
"lineTotalNet": 0,
"vatRate": 0,
"vatAmount": 0,
"category": "string"
}
],
"customer": {"email": "string",
"phone": "string",
"name": "string"
},
"classification": {"solution": "VARIABLE_AMOUNT",
"salesCategory": "string"
},
"completeness": {"hasLineItems": true,
"hasVatBreakdown": true,
"hasCustomerIdentity": true
}
}
],
"cursor": "string",
"hasMore": true
}