POST api/SigmaCommon/CustomerPaymentAuthentication

Request Information

URI Parameters

None.

Body Parameters

CustomerAuthentication
NameDescriptionTypeAdditional information
CustomerID

string

Required

BillingZipCode

string

Required

Matching regular expression pattern: ^\d{5}$

EmailID

string

None.

WebServiceKey

string

Required

CompanyID

integer

Required

AppSource

string

Required

AppSourceTeam

string

Required

Request Formats

application/json, text/json

Sample:
{
  "CustomerID": "sample string 1",
  "BillingZipCode": "sample string 2",
  "EmailID": "sample string 3",
  "WebServiceKey": "sample string 4",
  "CompanyID": 1,
  "AppSource": "sample string 5",
  "AppSourceTeam": "sample string 6"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuthenticationResult
NameDescriptionTypeAdditional information
ResponseCode

string

None.

ResponseMessage

string

None.

CustomerID

string

None.

CompanyID

integer

None.

TotalDueAmount

decimal number

None.

LastPaymentDate

string

None.

LastPaymentAmount

decimal number

None.

PastDueAmount

decimal number

None.

CurrentDueDate

string

None.

CurrentDueAmount

decimal number

None.

IsActive

boolean

None.

DisableACH

boolean

None.

DisableCC

boolean

None.

DisablePayment

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2",
  "CustomerID": "sample string 3",
  "CompanyID": 1,
  "TotalDueAmount": 1.0,
  "LastPaymentDate": "sample string 4",
  "LastPaymentAmount": 1.0,
  "PastDueAmount": 1.0,
  "CurrentDueDate": "sample string 5",
  "CurrentDueAmount": 1.0,
  "IsActive": true,
  "DisableACH": true,
  "DisableCC": true,
  "DisablePayment": true
}