getAccountBalance

ApiScope: payment.ach.fetch.account.balance
API Scope Level: DepartmentScope

Path Parameters

departmentUuid string required

Query Parameters

customerBankUuid string required

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

balance object
accountId string
name string
bankAccountType string
accountNumber string
availableBalance int64
currencyCode string
errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "balance": {
    "accountId": "string",
    "name": "string",
    "bankAccountType": "string",
    "accountNumber": "string",
    "availableBalance": 0,
    "currencyCode": "string"
  },
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

GET /kpayment/v1/:departmentUuid/achCustomer/bankBalance

Request

Base URL

/payment

departmentUuid — path required

customerBankUuid — query required

curl / cURL

curl -L -X GET '/payment/kpayment/v1/:departmentUuid/achCustomer/bankBalance' \
-H 'Accept: application/json'

python / requests

curl -L -X GET '/payment/kpayment/v1/:departmentUuid/achCustomer/bankBalance' \
-H 'Accept: application/json'

go / native

curl -L -X GET '/payment/kpayment/v1/:departmentUuid/achCustomer/bankBalance' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET '/payment/kpayment/v1/:departmentUuid/achCustomer/bankBalance' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET '/payment/kpayment/v1/:departmentUuid/achCustomer/bankBalance' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET '/payment/kpayment/v1/:departmentUuid/achCustomer/bankBalance' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET '/payment/kpayment/v1/:departmentUuid/achCustomer/bankBalance' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET '/payment/kpayment/v1/:departmentUuid/achCustomer/bankBalance' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET '/payment/kpayment/v1/:departmentUuid/achCustomer/bankBalance' \
-H 'Accept: application/json'