Trendsic Platform Service

CustomerPaymentsRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator, Agent, Administrator

The following routes are available for this service:
GET	/v1/CustomerPayments/{OrderID}
POST,PUT,OPTIONS	/v1/CustomerPayments

"use strict";
export class CustomerPayment {
    /** @param {{ID?:number,CustomerID?:number,OrderHeaderID?:number,Amount?:string,Approved?:boolean,AuthCode?:string,CardNumber?:string,Message?:string,ResponseCode?:number,TransactionId?:string,TransactionDate?:string,FullResponse?:string,PaymentStatus?:number,PaymentType?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {number} */
    CustomerID;
    /** @type {number} */
    OrderHeaderID;
    /** @type {string} */
    Amount;
    /** @type {boolean} */
    Approved;
    /** @type {string} */
    AuthCode;
    /** @type {string} */
    CardNumber;
    /** @type {string} */
    Message;
    /** @type {number} */
    ResponseCode;
    /** @type {string} */
    TransactionId;
    /** @type {string} */
    TransactionDate;
    /** @type {string} */
    FullResponse;
    /** @type {number} */
    PaymentStatus;
    /** @type {number} */
    PaymentType;
}
export class CustomerPaymentsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,PaymentIntentSuccess?:boolean,PaymentSuccess?:boolean,SubscriptionSuccess?:boolean,Message?:string,ReceiptUrl?:string,AgentNumber?:string,ClientSecret?:string,CustomerPayment?:CustomerPayment,PublicOrderID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {boolean} */
    PaymentIntentSuccess;
    /** @type {boolean} */
    PaymentSuccess;
    /** @type {boolean} */
    SubscriptionSuccess;
    /** @type {string} */
    Message;
    /** @type {string} */
    ReceiptUrl;
    /** @type {string} */
    AgentNumber;
    /** @type {string} */
    ClientSecret;
    /** @type {CustomerPayment} */
    CustomerPayment;
    /** @type {string} */
    PublicOrderID;
}
export class Customer {
    /** @param {{ID?:number,CustomerCode?:string,BusinessName?:string,FirstName?:string,LastName?:string,Email?:string,UID?:string,AgentId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    CustomerCode;
    /** @type {string} */
    BusinessName;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    Email;
    /** @type {string} */
    UID;
    /** @type {number} */
    AgentId;
}
export class PaymentInfo {
    /** @param {{PaymentType?:string,CardNumber?:string,ExpDate?:string,CCV?:string,StripeToken?:string,AgentId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PaymentType;
    /** @type {string} */
    CardNumber;
    /** @type {string} */
    ExpDate;
    /** @type {string} */
    CCV;
    /** @type {string} */
    StripeToken;
    /** @type {number} */
    AgentId;
}
export class CustomerPaymentsRequest {
    /** @param {{Customer?:Customer,OrderID?:string,PaymentInfo?:PaymentInfo}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Customer} */
    Customer;
    /** @type {string} */
    OrderID;
    /** @type {PaymentInfo} */
    PaymentInfo;
}

JavaScript CustomerPaymentsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/CustomerPayments HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomerPaymentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Customer>
    <AgentId>0</AgentId>
    <BusinessName>String</BusinessName>
    <CustomerCode>String</CustomerCode>
    <Email>String</Email>
    <FirstName>String</FirstName>
    <ID>0</ID>
    <LastName>String</LastName>
    <UID>00000000-0000-0000-0000-000000000000</UID>
  </Customer>
  <OrderID>00000000-0000-0000-0000-000000000000</OrderID>
  <PaymentInfo>
    <AgentId>0</AgentId>
    <CCV>String</CCV>
    <CardNumber>String</CardNumber>
    <ExpDate>String</ExpDate>
    <PaymentType>String</PaymentType>
    <StripeToken>String</StripeToken>
  </PaymentInfo>
</CustomerPaymentsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerPaymentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentNumber>String</AgentNumber>
  <ClientSecret>String</ClientSecret>
  <CustomerPayment>
    <Amount>String</Amount>
    <Approved>false</Approved>
    <AuthCode>String</AuthCode>
    <CardNumber>String</CardNumber>
    <CustomerID>0</CustomerID>
    <FullResponse>String</FullResponse>
    <ID>0</ID>
    <Message>String</Message>
    <OrderHeaderID>0</OrderHeaderID>
    <PaymentStatus>0</PaymentStatus>
    <PaymentType>0</PaymentType>
    <ResponseCode>0</ResponseCode>
    <TransactionDate>0001-01-01T00:00:00</TransactionDate>
    <TransactionId>String</TransactionId>
  </CustomerPayment>
  <Message>String</Message>
  <PaymentIntentSuccess>false</PaymentIntentSuccess>
  <PaymentSuccess>false</PaymentSuccess>
  <PublicOrderID>String</PublicOrderID>
  <ReceiptUrl>String</ReceiptUrl>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SubscriptionSuccess>false</SubscriptionSuccess>
</CustomerPaymentsResponse>