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
CustomerPaymentsRequest Parameters:
NameParameterData TypeRequiredDescription
CustomerbodyCustomerNo
OrderIDpathGuidNo
PaymentInfobodyPaymentInfoNo
Customer Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
CustomerCodeformstringNo
BusinessNameformstringNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
UIDformGuidNo
AgentIdformintNo
PaymentInfo Parameters:
NameParameterData TypeRequiredDescription
PaymentTypeformstringNo
CardNumberformstringNo
ExpDateformstringNo
CCVformstringNo
StripeTokenformstringNo
AgentIdformintNo
CustomerPaymentsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PaymentIntentSuccessformboolNo
PaymentSuccessformboolNo
SubscriptionSuccessformboolNo
MessageformstringNo
ReceiptUrlformstringNo
AgentNumberformstringNo
ClientSecretformstringNo
CustomerPaymentformCustomerPaymentNo
PublicOrderIDformstringNo
CustomerPayment Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
CustomerIDformintNo
OrderHeaderIDformintNo
AmountformstringNo
ApprovedformboolNo
AuthCodeformstringNo
CardNumberformstringNo
MessageformstringNo
ResponseCodeformintNo
TransactionIdformstringNo
TransactionDateformDateTimeNo
FullResponseformstringNo
PaymentStatusformintNo
PaymentTypeformintNo

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/jsv
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-01,
		FullResponse: String,
		PaymentStatus: 0,
		PaymentType: 0
	},
	PublicOrderID: String
}