PIpismo
Merchant advancement

Get advancement

Return information about an existing advancement. It returns fields such as dates, values, or status. If the advancement is only simulated but not yet in effect, the endpoint does not return any information.

get/v1/marketplaces/{marketplaceId}/merchants/{merchantId}/advancements/{advancementId}

Request

  • Base URL
    https://sandbox.pismolabs.io/merchants
  • URL
    https://sandbox.pismolabs.io/merchants/v1/marketplaces/{marketplaceId}/merchants/{merchantId}/advancements/{advancementId}
  • Auth
    none declared. Required headers: Authorization

Path parameters

marketplaceIdinteger required

Marketplace ID

merchantIdinteger required

Merchant ID

advancementIdinteger required

Advancement request ID

Headers

Authorizationstring required

Authorization token

Example:<your_token>

Response

OK

begin_datestring date

Start date used to search merchant transactions

end_datestring date nullable

End date used to search merchant transactions; null when not provided

request_datestring date

Advancement request date

advancement_gross_amountnumber float nullable

Gross amount of the merchant advancement, including all applicable rates; null when the advancement is not yet processed

advancement_net_amountnumber float nullable

Advancement net amount; null when the advancement is not yet processed

advancement_discount_amountnumber float nullable

Total amount of advancement discount; null when the advancement is not yet processed

advancement_feenumber float nullable

Fixed advancement rate; null when a value is provided for campaign_advancement_fee instead

campaign_advancement_feenumber float nullable

Fixed rate for requesting an advancement; null when the advancement uses the standard advancement_fee

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

Type of interest. For example, compound or simple

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

Advancement status

error_messagestring nullable

Error message; null when the status is either PROCESSED or PENDING

metadataobject nullable

Free-form metadata attached to the advancement; null when not provided

currency_codestring nullable

ISO 4217 alphanumeric currency code. When you do not want to record a transaction's currency code, use null.

Example response

{
  "begin_date": "2023-08-01",
  "end_date": "2023-08-31",
  "request_date": "2023-08-10",
  "advancement_gross_amount": 355,
  "advancement_net_amount": 300,
  "advancement_discount_amount": 50,
  "advancement_fee": 5,
  "interest_method": "SIMPLIFIED",
  "status": "PROCESSED",
  "currency_code": "BRL",
  "details": [
    {
      "merchant_id": 2,
      "merchant_name": "Merchant Pismo 1",
      "advancement_gross_amount": 355,
      "advancement_net_amount": 300,
      "advancement_discount_amount": 50,
      "discount_rate": 0.025,
      "maximum_advancement_percentage": 0.8
    }
  ]
}

Changes

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