POST | /payments/creditcard |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CreditCardPaymentList | body | List<CreditCardPayment> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
SubscriptionInfo | form | SubscriptionParameters | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FormTemplateID | form | int | No | |
SubscriptionInvoiceID | form | int | No | |
ClientSubscriberId | form | string | No | |
SignupTypeID | form | int | No | |
FrequencyID | form | int | No | |
AutoRenew | form | bool | No | |
CompanyID | form | long | No | |
UserID | form | int | No | |
ChapMemPayID | form | long | No | |
MemberSubscriptionInvID | form | long | No | |
Fields | form | List<SubscriberFormField> | No | |
CreatedBy | form | int | No | |
UpdatedBy | form | int | No | |
AptifyUpdateType | form | int | No | |
RenewedMemberSubscriptionInvID | form | long | No | |
ChapId | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Name | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClassName | form | string | No | |
UniqueId | form | string | No | |
CreatedDateTime | form | DateTime | No | |
ClientId | form | int | No | |
TransactionId | form | string | No | |
ErrorCode | form | int | No | |
ErrorMessage | 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 /payments/creditcard HTTP/1.1
Host: devapi.billhighway.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CreditCardPaymentList:
[
{
ClassName: String,
UniqueId: String,
CreatedDateTime: 0001-01-01,
ClientId: 0,
GroupId: String,
UserId: String,
BhUserId: 0,
Amount: String,
AutoPay: False,
CurrencyType: String,
Country: String,
CardReferenceOrCardNumber: String,
StoreCardInfo: False,
Address1: String,
Address2: String,
BillingCity: String,
BillingState: String,
PreferredEmailAddress: String,
Memo: String,
OpportunityId: String,
ExpMonth: 0,
ExpYear: 0,
Cvv: String,
PostalCode: String,
Location: String,
NameOnCard: String,
CardType: String,
InvoiceList:
[
{
ClassName: String,
UniqueId: String,
CreatedDateTime: 0001-01-01,
ClientId: 0,
Invoice: 0,
AmountPaid: String
}
]
}
]
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { ClassName: String, UniqueId: String, CreatedDateTime: 0001-01-01, ClientId: 0, TransactionId: String, ErrorCode: 0, ErrorMessage: String }