PIpismo
Merchant advancement

Simulate transaction advancement

Create or simulate a merchant advancement request for specified transactions. You can select which transaction you want to advance by specifying a merchant transaction ID. To trigger a simulated advancement request, you must include confirmAdvancement=false in the query string. If you specify true, the advancement request becomes an actual request, not a simulation.<br>

When a merchant advancement transaction is created, the endpoint produces Merchant transaction created and Merchant advancement transaction created events.

post/v1/marketplaces/{marketplaceId}/merchants/{merchantId}/advancements/transactions

Request

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

Path parameters

marketplaceIdinteger required

Marketplace ID

merchantIdinteger required

Merchant ID

Query parameters

confirmAdvancementboolean

When set to true, it means you are sending an actual advancement request (confirmed advancement); otherwise, it is a simulated advancement. The default value is false.

Flag that indicates whether this is an effective advancement or just a simulation. The default value is false.

Headers

Authorizationstring required

Authorization token

Example:<your_token>

Request body

request_datestring date required

Date for payment of the advancement (YYYY-MM-DD). Must be greater than or equal to today, where "today" is evaluated in the merchant program's resolved timezone. The organization's timezone is used as fallback.

real_time_settlementboolean required

If true, the transaction is settled in realtime; that is, at the exact moment. The default is false.

merchant_transaction_idsinteger[] required

List of Merchant Transaction IDs

campaign_advancement_feenumber float

Campaign advancement fee applied to the current advancement request. It replaces the advancement fee set for the merchant in the request.

campaign_discount_ratenumber float

Campaign discount rate applied to all merchants in the current advancement request.

Response

ACCEPTED

simulation_idstring

ID generated for the simulated advancement. This field is only returned if it is a simulation.

advancement_request_idinteger

This field is returned only if it's an actual advancement request (EFFECTIVE)

typestring

Operation type, returns either SIMULATION or EFFECTIVE

request_datestring date

Advancement request date

currency_codestring

ISO-4217 alphabetic (3 characters) currency code.

Example response

{
  "currency_code": "BRL"
}

Changes

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