Home / API Platform / Payment as a Service / Request.Authentication

Request.Authentication


Table of Contents  [ Hide]

Path: CnPAPI.Engine.Request.Authentication.

Elements

  • AccountGuid
  • AccountID

Schema:

 <xsd:element name="Authentication">
  <xsd:complexType>
   <xsd:sequence>
       <xsd:element ref="AccountGuid"/>
       <xsd:element ref="AccountID"/>
       <xsd:element ref="UserName" minOccurs="0"/>
       <xsd:element ref="Password" minOccurs="0"/>
      </xsd:sequence>
  </xsd:complexType>
 </xsd:element>

Example:

UserName & Password are maintained in the schema for backward compatibility. The elements are no longer used.

 <Authentication>
  <AccountGuid>xxx31189-9a80-41x9-99e7-xxxx4350893c</AccountGuid>
  <AccountID>12345</AccountID>
 </Authentication>

AccountGuid

A globally unique ID number provided by Click & Pledge.

Name  

AccountGuid  

Path  

CnPAPI.Engine.Request.Authentication.AccountGuid  

Description  

A unique identifier provided by Click & Pledge: Listed in the administrative system.  

Data Type  

String  

Range  

Maximum 36 characters  

Default  

 

Operation  

All operation  

Input/output  

Input  

Version/Release  

1.2  

Required  

Yes  

Example  

<AccountGuid>xxx31189-9a80-41x9-99e7-xxxx4350893c</AccountGuid>


Schema

 <xsd:element name="AccountGuid">
  <xsd:simpleType>
      <xsd:annotation>
          <xsd:documentation><![CDATA[A unique identifier provided by Click & Pledge: Listed in the administrative system.]]></xsd:documentation>
      </xsd:annotation>
      <xsd:restriction base="xsd:normalizedString">
          <xsd:minLength value="36"/>
          <xsd:maxLength value="36"/>
      </xsd:restriction>
  </xsd:simpleType>
 </xsd:element>

AccountID

Name  

AccountID  

Path  

CnPAPI.Engine.Request. Authentication.AccountID  

Description  

Trio account number  

Data Type  

Int  

Range  

Minimum: 1  

Maximum: 9999999999  

Default  

 

Operation  

All operation  

Input/output  

Input  

Version/Release  

1.2  

Required  

Yes  

Example  

<AccountID>12345</AccountID>

Schema

 <xsd:element name="AccountID">
  <xsd:simpleType>
      <xsd:annotation>
          <xsd:documentation>Trio account number</xsd:documentation>
      </xsd:annotation>
      <xsd:restriction base="xsd:long">
          <xsd:minInclusive value="1"/>
          <xsd:maxInclusive value="9999999999"/>
      </xsd:restriction>
  </xsd:simpleType>
 </xsd:element>




     RSS of this page