PIpismo
Configuration

Create accumulator configuration

Creates a new accumulator configuration, which keeps running totals for specified transaction types. Fees are applied to these totals based on an associated fee model.

After you create an accumulator configuration, you need to:

  1. <a href='https://developers.pismo.io/pismo-docs/reference/postmodel' target="_blank">Create a fee model</a> referencing the accumulator configuration.
  2. Attach the fee model to a <a href='https://developers.pismo.io/pismo-docs/reference/attachmentbyprogram' target="_blank">program<a> or <a href='https://developers.pismo.io/pismo-docs/reference/attachmentbyaccount' target="_blank">account<a>.
post/v1/accumulator-configs

Request

  • Base URL
    https://sandbox.pismolabs.io/accumulator
  • URL
    https://sandbox.pismolabs.io/accumulator/v1/accumulator-configs
  • Auth
    HTTP bearer

Headers

x-tenantstring
Example:TN-beaecb37-d149-4674-a485-af0d11e40d85

Organization/tenant ID

x-cidstring
Example:c737895c-8159-4c0c-a92a-a4f8600bff37

The Correlation IDentifier field is used to link related API requests and events. The CID can help the Pismo engineering team track everything related to a call. If not passed, a random one is generated. You can find the CID in the reponse header.

Request body

level'tenant' | 'account' required

Configuration level - org/tenant or account

account_idnumber

Pismo account ID

identifierstring required

Client-assigned accumulator configuration identifier for client tracking purposes. This identifier is used to <a href="https://developers.pismo.io/pismo-docs/reference/postmodel" target="_blank">create an accumulator fee model</a>.

increase_type'principal_amount' | 'contract_amount' required

Type of increase the accumulator will use for accumulating. principal_amount - The transaction amount without fees is accumulated. contract_amount - The transaction amount including fees is accumulated.

Example request

{
  "level": "account",
  "account_id": 8675309,
  "identifier": "total_cashout_config",
  "conditions": {
    "processing_code": {
      "include": [
        "00",
        "01"
      ],
      "exclude": [
        "99",
        "90"
      ]
    }
  },
  "increase_type": "principal_amount",
  "reset_strategy": {
    "time_window": {
      "timezone": "America/Sao_Paulo",
      "window": "daily",
      "month_day": 1
    }
  }
}

Response

Created

idstring
level'tenant' | 'account' required

Configuration level - org/tenant or account

account_idnumber

Pismo account ID

identifierstring required

Client-assigned accumulator configuration identifier for client tracking purposes. This identifier is used to <a href="https://developers.pismo.io/pismo-docs/reference/postmodel" target="_blank">create an accumulator fee model</a>.

increase_type'principal_amount' | 'contract_amount' required

Type of increase the accumulator will use for accumulating. principal_amount - The transaction amount without fees is accumulated. contract_amount - The transaction amount including fees is accumulated.

Example response

{
  "id": "3e6b3f44-1d1a-413c-8243-644618f53037",
  "level": "account",
  "account_id": 8675309,
  "identifier": "total_cashout_config",
  "conditions": {
    "processing_code": {
      "include": [
        "00",
        "01"
      ],
      "exclude": [
        "99",
        "90"
      ]
    }
  },
  "increase_type": "principal_amount",
  "reset_strategy": {
    "time_window": {
      "timezone": "America/Sao_Paulo",
      "window": "daily",
      "month_day": 1
    }
  }
}

Changes

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