POST api/cardService/v1/product/creditProfile

Request Information

URI Parameters

None.

Body Parameters

CreateCreditProfileRequestModel
NameDescriptionTypeAdditional information
ProfileName

string

Required

CreditLimit

decimal number

None.

IsPrePaid

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ProfileName": "sample string 1",
  "CreditLimit": 2.1,
  "IsPrePaid": true
}

application/xml, text/xml

Sample:
<CreateCreditProfileRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Qcs.WebApi.WebApiModels.Product">
  <CreditLimit>2.1</CreditLimit>
  <IsPrePaid>true</IsPrePaid>
  <ProfileName>sample string 1</ProfileName>
</CreateCreditProfileRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CreateCreditProfileResponseModel
NameDescriptionTypeAdditional information
CreditProfile

CreditProfileModel

None.

IsSuccess

boolean

Required

ErrorCodes

Collection of string

Required

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "CreditProfile": {
    "CreditProfileId": 1,
    "ProfileName": "sample string 2",
    "CreditLimit": 3.1,
    "AvailableBalance": 4.1,
    "IsPrePaid": true,
    "BalanceDue": 1.1,
    "AmountSpent": 1.1,
    "PaymentFrequency": "sample string 5",
    "PaymentTerms": "sample string 6",
    "PaymentType": "sample string 7",
    "SalesPersonCode": "sample string 8",
    "ChecksComplete": true,
    "Reseller": "sample string 9"
  },
  "IsSuccess": true,
  "ErrorCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<CreateCreditProfileResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Qcs.WebApi.WebApiModels.Product">
  <ErrorCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Qcs.WebApi.WebApiModels">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorCodes>
  <IsSuccess xmlns="http://schemas.datacontract.org/2004/07/Qcs.WebApi.WebApiModels">true</IsSuccess>
  <Message xmlns="http://schemas.datacontract.org/2004/07/Qcs.WebApi.WebApiModels">sample string 2</Message>
  <CreditProfile>
    <AmountSpent>1.1</AmountSpent>
    <AvailableBalance>4.1</AvailableBalance>
    <BalanceDue>1.1</BalanceDue>
    <ChecksComplete>true</ChecksComplete>
    <CreditLimit>3.1</CreditLimit>
    <CreditProfileId>1</CreditProfileId>
    <IsPrePaid>true</IsPrePaid>
    <PaymentFrequency>sample string 5</PaymentFrequency>
    <PaymentTerms>sample string 6</PaymentTerms>
    <PaymentType>sample string 7</PaymentType>
    <ProfileName>sample string 2</ProfileName>
    <Reseller>sample string 9</Reseller>
    <SalesPersonCode>sample string 8</SalesPersonCode>
  </CreditProfile>
</CreateCreditProfileResponseModel>