Trendsic Platform Service

<back to all web services

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
import Foundation
import ServiceStack

public class CustomerPaymentsRequest : Codable
{
    public var customer:Customer
    public var orderID:String
    public var paymentInfo:PaymentInfo

    required public init(){}
}

public class Customer : Codable
{
    public var id:Int
    public var customerCode:String
    public var businessName:String
    public var firstName:String
    public var lastName:String
    public var email:String
    public var uid:String
    public var agentId:Int

    required public init(){}
}

public class PaymentInfo : Codable
{
    public var paymentType:String
    public var cardNumber:String
    public var expDate:String
    public var ccv:String
    public var stripeToken:String
    public var agentId:Int

    required public init(){}
}

public class CustomerPaymentsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var paymentIntentSuccess:Bool
    public var paymentSuccess:Bool
    public var subscriptionSuccess:Bool
    public var message:String
    public var receiptUrl:String
    public var agentNumber:String
    public var clientSecret:String
    public var customerPayment:CustomerPayment
    public var publicOrderID:String

    required public init(){}
}

public class CustomerPayment : Codable
{
    public var id:Int
    public var customerID:Int
    public var orderHeaderID:Int
    public var amount:String
    public var approved:Bool
    public var authCode:String
    public var cardNumber:String
    public var message:String
    public var responseCode:Int
    public var transactionId:String
    public var transactionDate:Date
    public var fullResponse:String
    public var paymentStatus:Int
    public var paymentType:Int

    required public init(){}
}


Swift 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>