Merchant advancement

List merchant advancement requests

List advancement requests for a merchant, with optional filters by status and date ranges, plus pagination and sorting.

Date filters. beginDateFrom, beginDateTo, requestDateFrom, requestDateTo accept YYYY-MM-DD. The *From filters match advancements on or after the given date; the *To filters match advancements on or before it.

Pagination and sorting. page defaults to 1 and perPage defaults to 10; 0 is treated as the default for both. perPage accepts up to 100. order accepts asc or desc. orderBy accepts request_date, begin_date, end_date, status, or advancement_request_id; any other value is treated as request_date. The default sort is request_date DESC.

get/v2/merchants/{merchantId}/advancements

Request

Base URL
https://sandbox.pismolabs.io/merchants
URL
https://sandbox.pismolabs.io/merchants/v2/merchants/{merchantId}/advancements
Auth
none declared

Path parameters

merchantIdinteger required

Merchant ID

Query parameters

status'PENDING' | 'PROCESSED' | 'ERROR'

Filter advancement requests by exact status. Strict — any other value returns 400.

beginDateFromstring date

Filters advancements with begin_date on or after this date. Format = YYYY-MM-DD.

beginDateTostring date

Filters advancements with begin_date on or before this date. Format = YYYY-MM-DD. Must be greater than or equal to beginDateFrom when both are provided.

requestDateFromstring date

Filters advancements with request_date on or after this date. Format = YYYY-MM-DD.

requestDateTostring date

Filters advancements with request_date on or before this date. Format = YYYY-MM-DD. Must be greater than or equal to requestDateFrom when both are provided.

pageinteger

1-based page number. Defaults to 1 when omitted or set to 0.

perPageinteger

Number of items per page. Defaults to 10 when omitted or set to 0.

order'asc' | 'desc'

Sort order direction. Defaults to desc when omitted or set to empty string.

orderBystring

Column name to sort by. Unknown values fall back to the endpoint's default at the repository layer (no error).

Response

pageinteger required

1-based page number of the current response.

per_pageinteger required

Items per page applied to the current response.

has_nextboolean required

True when at least one more page exists after this one.

Example response

{
  "page": 1,
  "per_page": 10,
  "items": [
    {
      "advancement_request_id": 5531,
      "begin_date": "2026-04-20",
      "end_date": "2026-07-20",
      "request_date": "2026-04-15",
      "status": "PROCESSED",
      "interest_method": "COMPOUND",
      "advancement_gross_amount": 9876.5,
      "advancement_net_amount": 9756.05,
      "advancement_discount_amount": 120.45,
      "currency_code": "BRL"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.