CreditLimit

Summary

Get remaining account credit limit

Resource URL /api/v3/customer-account/{accountNumber}/credit-limit
HTTP method GET
Content type application/json; charset=utf-8

Input parameters

Parameter name Location Type / Model Description
accountNumber Path required
Account number

Responses

HTTP status code Model Comment
OK(200) GetRemainingLimitResponse Get remaining customer account credit limit response
BadRequest (400) array of ResponseMessage Request failed. Check response model for list of Errors.
Unauthorized (401) API user is unauthorized. Make sure X-Auth-Key header is sent.
InternalServerError (500) Request failed due internal error. Retry request later.

Examples

{
  "remainingCreditLimit": 68.5,
  "balance": 31.5,
  "isOpenForNewTransactions": true,
  "totalBalance": 31.5
}
var AfterPayApi = require("./afterPay.js");
var apiKeyAuthentication = require("./api_key_filter");

var key = 'CHANGE_ME';
var client = new AfterPayApi().addFilter(apiKeyAuthentication.create(key));
var accountNumber = "0100.0000006";

client.CustomerAccount.creditLimit(accountNumber, 
  function(err, response, httpRequest, httpResponse) {
  });
$LOAD_PATH.unshift File.dirname(__FILE__)
require 'after_pay.rb'
require 'json'

client = AfterPayApi::AfterPay.new(AfterPayApi::ApiKeyCredentials.new('YOUR_API_KEY'))

accountNumber = "0100.0000006";

client.customerAccount.creditLimit_async(accountNumber).then{|response|

}.execute.wait
var key = "CHANGE_ME";
var client = new CustomerAccountApi(new Configuration() { DefaultHeader = new Dictionary<string, string>() { { "X-Auth-Key", key} } });

var accountNumber = "0100.0000006";

var responce = client.CustomerAccountCreditLimit(accountNumber);