Trendsic Platform Service

<back to all web services

InvoiceRecordPaymentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
PUT,OPTIONS/v1/invoice/{InvoiceUID}/payment
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class InvoiceRecordPaymentRequest
    {
        public UUID InvoiceUID = null;
        public String StripeToken = null;
        
        public UUID getInvoiceUID() { return InvoiceUID; }
        public InvoiceRecordPaymentRequest setInvoiceUID(UUID value) { this.InvoiceUID = value; return this; }
        public String getStripeToken() { return StripeToken; }
        public InvoiceRecordPaymentRequest setStripeToken(String value) { this.StripeToken = value; return this; }
    }

    public static class InvoiceRecordPaymentResponse
    {
        public ResponseStatus ResponseStatus = null;
        public Boolean Success = null;
        public Boolean Paid = null;
        public String ReceiptUrl = null;
        public String Message = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public InvoiceRecordPaymentResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public Boolean isSuccess() { return Success; }
        public InvoiceRecordPaymentResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public Boolean isPaid() { return Paid; }
        public InvoiceRecordPaymentResponse setPaid(Boolean value) { this.Paid = value; return this; }
        public String getReceiptUrl() { return ReceiptUrl; }
        public InvoiceRecordPaymentResponse setReceiptUrl(String value) { this.ReceiptUrl = value; return this; }
        public String getMessage() { return Message; }
        public InvoiceRecordPaymentResponse setMessage(String value) { this.Message = value; return this; }
    }

}

Java InvoiceRecordPaymentRequest DTOs

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.

PUT /v1/invoice/{InvoiceUID}/payment HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	InvoiceUID: 00000000000000000000000000000000,
	StripeToken: String
}
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
		}
	},
	Success: False,
	Paid: False,
	ReceiptUrl: String,
	Message: String
}