PIpismo
Balance configurations

Get balance configuration

Get a balance configuration by its ID.

get/v1/balances-config/{configId}

Request

  • Base URL
    https://api-sandbox.pismolabs.io/balances-config
  • URL
    https://api-sandbox.pismolabs.io/balances-config/v1/balances-config/{configId}
  • Auth
    HTTP bearer

Path parameters

configIdstring required
Example:66954f26-aaef-49c2-b195-47a8f8410df1

Balance configuration ID

Headers

x-tenantstring required
Example:20167751b-efd4-494c-9e4f-4b939560ff05

Organization ID

x-cidstring
Example:12345

The Correlation Identifier UUID field links related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. If not passed, this field is automatically generated.

Response

OK

level'tenant' | 'program' | 'account'

Level to apply the balance configuration. (Note: tenant indicates an organization.) If level is tenant, the organization ID is parsed from the access token. You can implement the following operations for all levels:

  • Impact different balances.
  • Define the amount to impact balance.
  • Validate different balances or limits.
  • Define the amount to validate.
  • Define when the limit will be reset.

On the account level, two additional features are available:

  • Impact a related account.
  • Define a counterpart account.
program_idinteger

Program ID. REQUIRED if level is program.

account_idinteger

Account ID. REQUIRED if level is account.

config_idstring

Balance configuration ID

Example response

{
  "level": "program",
  "program_id": 999,
  "account_id": 999,
  "config_id": "041ee495-268a-4267-b53a-5b9532a53e45",
  "global_configs": {
    "impact_parent_accounts": true
  },
  "configs": [
    {
      "name": "Config-multiple-accounts",
      "is_active": true,
      "filter_template_id": "test-1",
      "filters": {
        "processing_codes": [
          "01",
          "03"
        ],
        "min_installments": 1,
        "max_installments": 12,
        "mcc": [
          "1234",
          "2626"
        ],
        "account_type": "00",
        "currency_code": "USD"
      },
      "scenarios": [
        {
          "condition": {
            "order": 1,
            "type": "custom",
            "amount_to_check_balance": "amount"
          },
          "result": {
            "amount": "contract_amount",
            "impact": [
              "AvailableCreditLimit"
            ],
            "consider": [
              "OverLimit",
              "AvailableCreditLimit"
            ],
            "amount_consider": "principal_amount",
            "reset_limit": "never",
            "impact_account": {
              "account_id": 999,
              "customer_id": 5678
            },
            "counterpart_account": {
              "account_id": 999,
              "processing_code": "007700"
            },
            "confirmation": {
              "impact": [
                "AvailableCreditLimit"
              ],
              "opposite_impact": [
                "HeldFunds"
              ]
            },
            "opposite_impact": [
              "HeldFunds"
            ]
          }
        }
      ]
    }
  ]
}

Changes

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