PIpismo
Marketplace creditor operations

Create marketplace creditor operations

Create multiple creditor operations for the specified marketplace.

This endpoint creates one creditor operation for each merchant ID and each installment in the request body. The values of processing_code and start_date are replicated to each creditor operation created based on the installments configuration.

This endpoint generates Marketplace creditor operation created events.

post/v2/marketplaces/{marketplaceId}/creditors-operations

Request

  • Base URL
    https://sandbox.pismolabs.io/marketplace
  • URL
    https://sandbox.pismolabs.io/marketplace/v2/marketplaces/{marketplaceId}/creditors-operations
  • Auth
    HTTP bearer

Path parameters

marketplaceIdinteger required

Marketplace ID

Headers

Authorizationstring

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

Request body

merchant_idsinteger[] required

List of merchants that this creditor operation applies to

Example request

{
  "merchant_ids": [
    1,
    2,
    3,
    4,
    5
  ],
  "creditor_operation": {
    "processing_code": "700203",
    "start_date": "2022-12-21",
    "installments": [
      {
        "installment": 1,
        "first_installment_days_to_payment": 30,
        "n_installment_days_to_payment": 30,
        "transaction_fee": 0,
        "mdr": 0.01,
        "matched_mdr": true,
        "matched_settlement": true,
        "work_days": false,
        "fees": [
          {
            "name": "EMISSION_FEE",
            "value": 1.5
          },
          {
            "name": "MAINTENANCE_FEE",
            "value": 0.01
          }
        ]
      },
      {
        "installment": 2,
        "first_installment_days_to_payment": 30,
        "n_installment_days_to_payment": 30,
        "transaction_fee": 0.5,
        "mdr": 0.01,
        "matched_mdr": true,
        "matched_settlement": true,
        "work_days": false,
        "fees": [
          {
            "name": "EMISSION_FEE",
            "value": 1.7
          },
          {
            "name": "MAINTENANCE_FEE",
            "value": 0.02
          }
        ]
      }
    ]
  }
}

Response

Created

Changes

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