Merchant advancement

Create advancement request (outdated)

Create advancement request for merchant. An advancement is the same as an anticipation of receivables or a prepayment of receivables. 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.<br> This endpoint produces a Merchant advancement request created event.

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

post/v2/merchants/{merchantId}/advancements

Request

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

Path parameters

merchantIdinteger required

Example:1

Merchant ID

Headers

Content-Typestring

Example:application/json

Content type

Authorizationstring

Example:Bearer 1JI12J39182H39182JDIOAWJ%=

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

Request body

begin_datestring required

Begin date (DD/MM/YYYY)

amountnumber float required

Advancement amount

request_datestring

Request date (DD/MM/YYYY)

end_datestring

End date (DD/MM/YYYY)

notifystring

URL that receives notification

real_time_settlementboolean

Indicates whether transaction is settled in real time.

Example request

{
  "begin_date": "31/07/2021",
  "amount": 988.9,
  "request_date": "07/07/2021",
  "end_date": "02/05/2023",
  "notify": "pismo.io/notify"
}

Response

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

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.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
}

Changes

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