---
title: "Get advancement"
method: GET
path: "/v1/marketplaces/{marketplaceId}/merchants/{merchantId}/advancements/{advancementId}"
tags: ["Merchant advancement"]
---

# Get advancement

`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`

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.

## Path parameters

- `marketplaceId` integer, required: Marketplace ID
- `merchantId` integer, required: Merchant ID
- `advancementId` integer, required

## Headers

- `Authorization` string, required: Authorization token

## Response `200`

OK

- AdvancementDataResponse
  - `begin_date` string, date: Start date used to search merchant transactions
  - `end_date` string, date, nullable: End date used to search merchant transactions; `null` when not provided
  - `request_date` string, date: Advancement request date
  - `advancement_gross_amount` number, float, nullable: Gross amount of the merchant advancement, including all applicable rates; `null` when the advancement is not yet processed
  - `advancement_net_amount` number, float, nullable: Advancement net amount; `null` when the advancement is not yet processed
  - `advancement_discount_amount` number, float, nullable: Total amount of advancement discount; `null` when the advancement is not yet processed
  - `advancement_fee` number, float, nullable: Fixed advancement rate; `null` when a value is provided for `campaign_advancement_fee` instead
  - `campaign_advancement_fee` number, 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_message` string, nullable: Error message; `null` when the status is either `PROCESSED` or `PENDING`
  - `metadata` object, nullable: Free-form metadata attached to the advancement; `null` when not provided
  - `currency_code` string, nullable: ISO 4217 alphanumeric currency code. When you do not want to record a transaction's currency code, use `null`.
  - `details` object[]: Per-merchant breakdown; empty array when the request is not processed or returns an error
    - `merchant_id` integer: Merchant ID used in the advancement request
    - `merchant_name` string: Merchant name
    - `advancement_gross_amount` number, float: Total amount of advancement
    - `advancement_net_amount` number, float: Net amount of advancement
    - `advancement_discount_amount` number, float: Total discount amount
    - `discount_rate` number, float, nullable: Merchant discount rate; `null` when the discount rate is a campaign rate (in which case `campaign_discount_rate` is populated)
    - `campaign_discount_rate` number, float, nullable: Campaign discount rate; `null` when the discount rate is the standard merchant rate (in which case `discount_rate` is populated)
    - `maximum_advancement_percentage` number, float, nullable: Maximum allowable percentage of the net amount for the advancement; `null` when not configured
    - `transaction_ids` integer[]: Transaction ID used by the merchant who makes the advancement request. This ID is generated by Pismo

## Other responses

- `400`: BAD REQUEST
- `404`: Marketplace or merchant does not belong to the tenant, or the advancement was not found for the given identifiers

---

[API](https://skmtc.dev/pismo/apis/seller-management-merchant-advancements.md) - [All operations](https://skmtc.dev/pismo/apis/seller-management-merchant-advancements/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/seller-management-merchant-advancements/revisions/3cb3ff54cef7?raw)