| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET | /v1/CustomerPayments/{OrderID} | ||
|---|---|---|---|
| POST,PUT,OPTIONS | /v1/CustomerPayments |
namespace CRM.AgencyPlatform.API.Internal
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type CustomerPayment() =
member val ID:Int32 = new Int32() with get,set
member val CustomerID:Int32 = new Int32() with get,set
member val OrderHeaderID:Int32 = new Int32() with get,set
member val Amount:String = null with get,set
member val Approved:Boolean = new Boolean() with get,set
member val AuthCode:String = null with get,set
member val CardNumber:String = null with get,set
member val Message:String = null with get,set
member val ResponseCode:Int32 = new Int32() with get,set
member val TransactionId:String = null with get,set
member val TransactionDate:DateTime = new DateTime() with get,set
member val FullResponse:String = null with get,set
member val PaymentStatus:Int32 = new Int32() with get,set
member val PaymentType:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type CustomerPaymentsResponse() =
member val ResponseStatus:ResponseStatus = null with get,set
member val PaymentIntentSuccess:Boolean = new Boolean() with get,set
member val PaymentSuccess:Boolean = new Boolean() with get,set
member val SubscriptionSuccess:Boolean = new Boolean() with get,set
member val Message:String = null with get,set
member val ReceiptUrl:String = null with get,set
member val AgentNumber:String = null with get,set
member val ClientSecret:String = null with get,set
member val CustomerPayment:CustomerPayment = null with get,set
member val PublicOrderID:String = null with get,set
[<AllowNullLiteral>]
type Customer() =
member val ID:Int32 = new Int32() with get,set
member val CustomerCode:String = null with get,set
member val BusinessName:String = null with get,set
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val Email:String = null with get,set
member val UID:Guid = new Guid() with get,set
member val AgentId:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type PaymentInfo() =
member val PaymentType:String = null with get,set
member val CardNumber:String = null with get,set
member val ExpDate:String = null with get,set
member val CCV:String = null with get,set
member val StripeToken:String = null with get,set
member val AgentId:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type CustomerPaymentsRequest() =
member val Customer:Customer = null with get,set
member val OrderID:Guid = new Guid() with get,set
member val PaymentInfo:PaymentInfo = null with get,set
F# CustomerPaymentsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>