menu

Payment API

What's on this page

API Reference / Balance

Balance

For enabled collecting methods a balance can be given or requested to show why an action has failed, or to allow a merchant to see which actions will be possible depending on the available balance. For example, when a refund fails the balance calculated during the process will be returned to show the merchant is short if applicable.

Balance object

Name Description
creditAmount The sum of all refunds not yet paid out
debitAmount The sum of all sales and captures not yet paid out
total The total available balance. The difference between debitAmount and creditAmount
brand Present if obtained via the balance request. Uniquely identifies the balance amount for a specific brand of methods card or applepay
country Present if obtained via the balance request. Uniquely identifies the balance amount for a specific customer’s billingCountry of method banktransfer

Balance request

The balance request is used to return a list of available payment methods for the merchant with the associated balance amounts. The list is a JSON array containing an item per method. Each item contains the method name and available balance(s).

  • Resource: /api/v1/balance
  • Method: GET
  • Parameter: Optional Request parameter ‘methods’, a comma separated list of method names used to filter balances. Defaults to all method-balances if omitted.
  • Authentication: basic auth

Balance response

  • Status Code: 200
  • Content Type: application/json

Example

curl https://api.psp.ccv.eu/api/v1/balance -u apikey:

Example with list of method names

curl https://api.psp.ccv.eu/api/v1/balance?methods=card,ideal,payconiq,alipay,applepay -u apikey:

[
  {
    "method": "ideal",
    "balances": [
      {
        "creditAmount": 0,
        "debitAmount": 0.10,
        "total": 0.10
      }
    ]
  },
  {
    "method": "card",
    "balances": [
      {
        "creditAmount": 0,
        "debitAmount": 19.98,
        "total": 19.98,
        "brand": "bcmc"
      }
    ]
  },
  {
    "method": "payconiq",
    "balances": [
      {
        "creditAmount": 0,
        "debitAmount": 0,
        "total": 0
      }
    ]
  },
  {
    "method": "alipay",
    "balances": [
      {
        "creditAmount": 0,
        "debitAmount": 0,
        "total": 0
      }
    ]
  },
  {
    "method": "applepay",
    "balances": [
      {
        "creditAmount": 0,
        "debitAmount": 0,
        "total": 0,
        "brand": "visa"
      },
      {
        "creditAmount": 0,
        "debitAmount": 19.98,
        "total": 19.98,
        "brand": "bcmc"
      }
    ]
  }
]