| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,OPTIONS | /v1/StripeCustomer | ||
|---|---|---|---|
| PUT,OPTIONS | /v1/StripeCustomer | ||
| POST,OPTIONS | /v1/StripeCustomer |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Customer | body | Customer | No | |
| Address | body | Address | 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 |
|---|---|---|---|---|
| ID | form | int | No | |
| AddressTypeID | form | byte | No | |
| AddressContact | form | string | No | |
| AttentionTo | form | string | No | |
| AddressLine1 | form | string | No | |
| AddressLine2 | form | string | No | |
| AddressLine3 | form | string | No | |
| AddressCity | form | string | No | |
| AddressState | form | string | No | |
| AddressZip | form | string | No | |
| AddressCountry | form | string | No | |
| PhoneNumber | form | string | No | |
| FaxNumber | form | string | No | |
| UID | form | Guid | No | |
| Name | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| StripeCustomer | form | StripeCustomer | No | |
| Success | form | bool | No | |
| Message | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StripeCustomerId | form | int | No | |
| StripeMerchantId | form | int | No | |
| CustomerId | form | int | No | |
| StripeId | form | string | No | |
| AgentId | form | int | No | |
| StripeCustomerSessionClientSecret | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/StripeCustomer 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
},
Address:
{
ID: 0,
AddressTypeID: 0,
AddressContact: String,
AttentionTo: String,
AddressLine1: String,
AddressLine2: String,
AddressLine3: String,
AddressCity: String,
AddressState: String,
AddressZip: String,
AddressCountry: String,
PhoneNumber: String,
FaxNumber: String,
UID: 00000000000000000000000000000000,
Name: 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
}
},
StripeCustomer:
{
StripeCustomerId: 0,
StripeMerchantId: 0,
CustomerId: 0,
StripeId: String,
AgentId: 0,
StripeCustomerSessionClientSecret: String
},
Success: False,
Message: String
}