PIpismo
Merchant advancement

Get advancement request (outdated)

Get an advancement request using an advancement request ID and a merchant ID. 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.

(<strong>Outdated:</strong> For an updated version of the get advancement request endpoint refer to Get Advancement.)

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

Request

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

Path parameters

merchantIdinteger required
Example:1

Merchant ID

advancementRequestIdinteger required
Example:995

Advancement request ID

Headers

Authorizationstring
Example:Bearer 1JI12J39182H39182JDIOAWJ%=

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

Response

OK

advancement_request_idinteger

Advancement request ID

date_of_requeststring datetime

The date and time the advancement is requested. Note that the date and time are displayed in UTC format yyyy-MM-ddThh:mm:ssZ.

amount_requestedstring

Amount requested

begin_datestring

Begin date (DD/MM/YYYY)

end_datestring

End date (DD/MM/YYYY)

advancement_feestring

Advancement fee for creditor.

discount_ratestring

Advancement discount rate for creditor.

maximum_advancement_percentagestring

Maximum advancement percentage for creditor.

interest_method'SIMPLE' | 'COMPOUND' | 'SIMPLIFIED'

Advancement interest mode

schedule_payment_date_update_mode'KEEP_FUTURE_DATES' | 'UPDATE_TO_NOW'

Mode for updating advancement schedule payment date

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

Advancement status

messagestring

Feedback message for advancement request

notifystring

URL that receives notification

advanced_gross_amountnumber

Gross amount advanced

advanced_discount_amountnumber float

AdvancementDiscountAmount

advanced_net_amountnumber

Net amount advanced

group_transactions'TOTAL' | 'NETWORK'

Advancement group transactions

initial_transaction_status'SCHEDULED' | 'SETTLED'

Initial transaction status for advancement

Example response

{
  "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,
  "discount_rate": 0.02,
  "maximum_advancement_percentage": 1,
  "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.