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

export class InvoiceRecordPaymentResponse
{
    public ResponseStatus: ResponseStatus;
    public Success: boolean;
    public Paid: boolean;
    public ReceiptUrl: string;
    public Message: string;

    public constructor(init?: Partial<InvoiceRecordPaymentResponse>) { (Object as any).assign(this, init); }
}

export class InvoiceRecordPaymentRequest
{
    public InvoiceUID: string;
    public StripeToken: string;

    public constructor(init?: Partial<InvoiceRecordPaymentRequest>) { (Object as any).assign(this, init); }
}

TypeScript InvoiceRecordPaymentRequest DTOs

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

HTTP + CSV

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

{"InvoiceUID":"00000000000000000000000000000000","StripeToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}