List purchases by aggregator

get

https://mo-services-zero-production.moprestamo.com/api/purchases/{aggregator_id}/purchases

Returns the purchases originated under a given aggregator and its descendants, used by partners to reconcile point-of-sale financed purchases scoped to a single aggregator.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

aggregator_id

uuid

required

Aggregator identifier whose purchases are being listed (must be the caller or a descendant).

Query Params

uuid

Exact match on purchase id.

external_id

string

Exact match on purchase external id.

reference

string

Exact match on purchase reference.

reference__in

string

Comma-separated list of purchase references (in lookup).

status

string

Filters on the purchase label (status shown to partners).

offer_name

string

Filter by the offer's name.

customer_name

string

Filter by the customer's name.

username

string

Filter by the customer's username.

created_at

date

Filter by purchase creation calendar date (date lookup).

created_at__gte

date

Include purchases created on or after this date.

created_at__gt

date

Include purchases created after this date.

created_at__lte

date

Include purchases created on or before this date.

created_at__lt

date

Include purchases created before this date.

ticket

number

Exact match on the purchase ticket amount.

ticket__gte

number

Ticket amount greater than or equal to this value.

ticket__gt

number

Ticket amount greater than this value.

ticket__lte

number

Ticket amount less than or equal to this value.

ticket__lt

number

Ticket amount less than this value.

downpayment

number

Exact match on the purchase downpayment amount.

downpayment__gte

number

Downpayment amount greater than or equal to this value.

downpayment__gt

number

Downpayment amount greater than this value.

downpayment__lte

number

Downpayment amount less than or equal to this value.

downpayment__lt

number

Downpayment amount less than this value.

product_id

uuid

Exact match on product id.

currency_id

uuid

Exact match on currency id.

string

Free-text match across purchase reference/external id, aggregator reference/external id, customer reference/external id/display name/national id, or an exact id/aggregator_id/customer_id when the value is a valid UUID.

ordering

string

Sort the results by any field present in the response. Prefix the name with - for descending order, for example -created_at. Defaults to newest first.

limit

int32

Maximum number of items to return.

offset

int32

Pagination offset.

Headers

x-api-key

string

required

API key generated for client authentication.

x-aggregator-id

string

required

Aggregator identifier for request ownership.

Responses

500

Internal server error

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400400

401401

403403

404404

423423