Merchant advancement

List advancement requests

List advancements requested by merchant. An advancement is the same as a receivable or a prepayment of a receivable. An example of a situation in which a seller might use advancements is if it has a deal with a large customer who it knows is going to take some time to pay its bills. To cover its business expenses in the meantime, the seller could make a deal with a bank to pay it for the goods sold at the time of sale. The seller later repays the bank when it gets paid by its customer. The bank profits because the seller pays a fee for each advancement.

get/v1/merchants/{merchantId}/advancements/requests

Request

Base URL
https://sandbox.pismolabs.io/merchants
URL
https://sandbox.pismolabs.io/merchants/v1/merchants/{merchantId}/advancements/requests
Auth
HTTP bearer

Path parameters

merchantIdinteger required

Example:1

Merchant ID

Query parameters

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

Example:PENDING

Advancement request status

pageinteger

Example:1

Page number. Default is 1.

perPageinteger

Example:10

Items per page. Default is 10.

Headers

Authorizationstring

Example:Bearer 1JI12J39182H39182JDIOAWJ%=

Authorization token. This is a regular access token, which does not need to include an account ID.

Response

total_itemsinteger

Total number of items

per_pageinteger

Number of items per page

pagesinteger

Number of pages

current_pageinteger

Current page number

Example response

{
  "total_items": 2,
  "per_page": 1,
  "pages": 2,
  "current_page": 1,
  "items": [
    {
      "advancement_request_id": 995,
      "date_of_request": "2019-05-14T15:58:10Z",
      "amount_requested": "346.99",
      "begin_date": "2019-05-30",
      "end_date": "2019-06-30",
      "advancement_fee": "10.0",
      "discount_rate": "0.02",
      "maximum_advancement_percentage": "1.0",
      "interest_method": "SIMPLE",
      "schedule_payment_date_update_mode": "KEEP_FUTURE_DATES",
      "status": "PENDING",
      "message": "Advancement request successfully completed in 10 seconds.",
      "advanced_gross_amount": 637.53,
      "advanced_discount_amount": -41.43,
      "advanced_net_amount": 596.1,
      "group_transactions": "TOTAL",
      "initial_transaction_status": "SCHEDULED"
    }
  ]
}

Changes

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