| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET | /v1/CustomerPayments/{OrderID} | ||
|---|---|---|---|
| POST,PUT,OPTIONS | /v1/CustomerPayments |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Customer | body | Customer | No | |
| OrderID | path | Guid | No | |
| PaymentInfo | body | PaymentInfo | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | int | No | |
| CustomerCode | form | string | No | |
| BusinessName | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| form | string | No | ||
| UID | form | Guid | No | |
| AgentId | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentType | form | string | No | |
| CardNumber | form | string | No | |
| ExpDate | form | string | No | |
| CCV | form | string | No | |
| StripeToken | form | string | No | |
| AgentId | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| PaymentIntentSuccess | form | bool | No | |
| PaymentSuccess | form | bool | No | |
| SubscriptionSuccess | form | bool | No | |
| Message | form | string | No | |
| ReceiptUrl | form | string | No | |
| AgentNumber | form | string | No | |
| ClientSecret | form | string | No | |
| CustomerPayment | form | CustomerPayment | No | |
| PublicOrderID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ID | form | int | No | |
| CustomerID | form | int | No | |
| OrderHeaderID | form | int | No | |
| Amount | form | string | No | |
| Approved | form | bool | No | |
| AuthCode | form | string | No | |
| CardNumber | form | string | No | |
| Message | form | string | No | |
| ResponseCode | form | int | No | |
| TransactionId | form | string | No | |
| TransactionDate | form | DateTime | No | |
| FullResponse | form | string | No | |
| PaymentStatus | form | int | No | |
| PaymentType | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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"}