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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class Customer
            Public Overridable Property ID As Integer
            Public Overridable Property CustomerCode As String
            Public Overridable Property BusinessName As String
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property Email As String
            Public Overridable Property UID As Guid
            Public Overridable Property AgentId As Integer
        End Class

        Public Partial Class CustomerPayment
            Public Overridable Property ID As Integer
            Public Overridable Property CustomerID As Integer
            Public Overridable Property OrderHeaderID As Integer
            Public Overridable Property Amount As String
            Public Overridable Property Approved As Boolean
            Public Overridable Property AuthCode As String
            Public Overridable Property CardNumber As String
            Public Overridable Property Message As String
            Public Overridable Property ResponseCode As Integer
            Public Overridable Property TransactionId As String
            Public Overridable Property TransactionDate As Date
            Public Overridable Property FullResponse As String
            Public Overridable Property PaymentStatus As Integer
            Public Overridable Property PaymentType As Integer
        End Class

        Public Partial Class CustomerPaymentsRequest
            Public Overridable Property Customer As Customer
            Public Overridable Property OrderID As Guid
            Public Overridable Property PaymentInfo As PaymentInfo
        End Class

        Public Partial Class CustomerPaymentsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property PaymentIntentSuccess As Boolean
            Public Overridable Property PaymentSuccess As Boolean
            Public Overridable Property SubscriptionSuccess As Boolean
            Public Overridable Property Message As String
            Public Overridable Property ReceiptUrl As String
            Public Overridable Property AgentNumber As String
            Public Overridable Property ClientSecret As String
            Public Overridable Property CustomerPayment As CustomerPayment
            Public Overridable Property PublicOrderID As String
        End Class

        Public Partial Class PaymentInfo
            Public Overridable Property PaymentType As String
            Public Overridable Property CardNumber As String
            Public Overridable Property ExpDate As String
            Public Overridable Property CCV As String
            Public Overridable Property StripeToken As String
            Public Overridable Property AgentId As Integer
        End Class
    End Namespace
End Namespace

VB.NET CustomerPaymentsRequest DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Customer":{"ID":0,"CustomerCode":"String","BusinessName":"String","FirstName":"String","LastName":"String","Email":"String","UID":"00000000000000000000000000000000","AgentId":0},"OrderID":"00000000000000000000000000000000","PaymentInfo":{"PaymentType":"String","CardNumber":"String","ExpDate":"String","CCV":"String","StripeToken":"String","AgentId":0}}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"PaymentIntentSuccess":false,"PaymentSuccess":false,"SubscriptionSuccess":false,"Message":"String","ReceiptUrl":"String","AgentNumber":"String","ClientSecret":"String","CustomerPayment":{"ID":0,"CustomerID":0,"OrderHeaderID":0,"Amount":"String","Approved":false,"AuthCode":"String","CardNumber":"String","Message":"String","ResponseCode":0,"TransactionId":"String","TransactionDate":"0001-01-01T00:00:00.0000000","FullResponse":"String","PaymentStatus":0,"PaymentType":0},"PublicOrderID":"String"}