| Required role: | Admin |
| OPTIONS | /R_TransactionInfo |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | query | long | No | |
| Transaction | query | R_Transaction | No | |
| Subscription | query | R_Subscription | No | |
| AccountHolder | query | R_AccountHolder | No | |
| Registration | query | R_Registration | No | |
| TotalNumberOfRecords | query | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubscriptionId | form | long | No | |
| GatewayTransactionId | form | string | No | |
| TransactionTypeId | form | long | No | |
| TransactionStatusId | form | long | No | |
| Amount | form | decimal | No | |
| Card | form | string | No | |
| CurrencyId | form | long | No | |
| CreateDate | form | DateTime | No | |
| InvoiceId | form | long? | No | |
| GatewayResponse | form | string | No | |
| TransactionNotificationStatusId | form | long | No | |
| SettlementDate | form | DateTime? | No | |
| RelatedTransactionId | form | long? | No | |
| RelatedGatewayTransactionId | form | string | No | |
| Id | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AccountHolderId | form | long | No | |
| RegistrationId | form | long | No | |
| UnitId | form | string | No | |
| SubscriptionStatusTypeId | form | long | No | |
| BrandId | form | long | No | |
| StartDate | form | DateTime | No | |
| PreviousBillDate | form | DateTime? | No | |
| CurrentBillDate | form | DateTime? | No | |
| NextBillDate | form | DateTime? | No | |
| PaidUntil | form | DateTime? | No | |
| NumberOfOccurrences | form | int | No | |
| BillingInterval | form | int | No | |
| BillingIntervalTimeUnitId | form | long | No | |
| TrialOccurrences | form | int? | No | |
| TrialBillingInterval | form | int? | No | |
| TrialBillingIntervalTimeUnitId | form | long? | No | |
| SubscriptionBillingStatusId | form | long? | No | |
| Id | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| AccountId | form | long | No | |
| CreationDateTime | form | DateTime? | No | |
| form | string | No | ||
| PhoneNumber | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| Address1 | form | string | No | |
| Address2 | form | string | No | |
| City | form | string | No | |
| StateProvince | form | string | No | |
| ZipCode | form | string | No | |
| Country | form | string | No | |
| CreditCardNumber | form | string | No | |
| CardCode | form | string | No | |
| ExpirationMonth | form | int? | No | |
| ExpirationYear | form | int? | No | |
| NeedToUpdatePaymentInfo | form | bool | No | |
| UpdatePaymentInfoDate | form | DateTime? | No | |
| TotalNumberOfRecords | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | No | |
| UnitId | form | string | No | |
| MerchantId | form | string | No | |
| CreationDateTime | form | DateTime? | No | |
| RegistrationStatus | form | long | No | |
| AccountId | form | long? | No | |
| ProductId | form | long | No | |
| ProductName | form | string | No | |
| PlanId | form | long? | No | |
| PlanName | form | string | No | |
| SubscriptionId | form | long? | No | |
| CellularServiceId | form | long? | No | |
| BrandId | form | long | No | |
| BrandName | form | string | No | |
| EligibleBundleId | form | long? | No | |
| BundleName | form | string | No | |
| ResellerId | form | long? | No | |
| ResellerName | form | string | No | |
| CellularService | form | R_CellularService | No | |
| Subscription | form | R_Subscription | No | |
| TotalNumberOfRecords | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RegistrationId | form | long | No | |
| UnitId | form | string | No | |
| ProductName | form | string | No | |
| CellDeviceId | form | string | No | |
| DeviceSerialNumber | form | string | No | |
| PhoneNumber | form | string | No | |
| BrandName | form | string | No | |
| ProfileId | form | long | No | |
| CellularDeviceStateId | form | long | No | |
| CreateDateTime | form | DateTime | No | |
| LastUpdatDateTime | form | DateTime | No | |
| ContactEmail | form | string | No | |
| Id | form | long | No | |
| TotalNumberOfRecords | form | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StartIndex | form | long? | No | |
| NumberOfRecords | form | long? | No | |
| BrandIds | form | List<long> | No | |
| TransactionStatusIds | form | List<long> | 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 /jsv/reply/R_TransactionInfo HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Transaction:
{
SubscriptionId: 0,
GatewayTransactionId: String,
TransactionTypeId: 0,
TransactionStatusId: 0,
Amount: 0,
Card: String,
CurrencyId: 0,
CreateDate: 0001-01-01,
InvoiceId: 0,
GatewayResponse: String,
TransactionNotificationStatusId: 0,
SettlementDate: 0001-01-01,
RelatedTransactionId: 0,
RelatedGatewayTransactionId: String,
Id: 0
},
Subscription:
{
AccountHolderId: 0,
RegistrationId: 0,
UnitId: String,
SubscriptionStatusTypeId: 0,
BrandId: 0,
StartDate: 0001-01-01,
PreviousBillDate: 0001-01-01,
CurrentBillDate: 0001-01-01,
NextBillDate: 0001-01-01,
PaidUntil: 0001-01-01,
NumberOfOccurrences: 0,
BillingInterval: 0,
BillingIntervalTimeUnitId: 0,
TrialOccurrences: 0,
TrialBillingInterval: 0,
TrialBillingIntervalTimeUnitId: 0,
SubscriptionBillingStatusId: 0,
Id: 0
},
AccountHolder:
{
Id: 0,
AccountId: 0,
CreationDateTime: 0001-01-01,
Email: String,
PhoneNumber: String,
FirstName: String,
LastName: String,
Address1: String,
Address2: String,
City: String,
StateProvince: String,
ZipCode: String,
Country: String,
CreditCardNumber: String,
CardCode: String,
ExpirationMonth: 0,
ExpirationYear: 0,
NeedToUpdatePaymentInfo: False,
UpdatePaymentInfoDate: 0001-01-01,
TotalNumberOfRecords: 0
},
Registration:
{
Id: 0,
UnitId: String,
MerchantId: String,
CreationDateTime: 0001-01-01,
RegistrationStatus: 0,
AccountId: 0,
ProductId: 0,
ProductName: String,
PlanId: 0,
PlanName: String,
SubscriptionId: 0,
CellularServiceId: 0,
BrandId: 0,
BrandName: String,
EligibleBundleId: 0,
BundleName: String,
ResellerId: 0,
ResellerName: String,
CellularService:
{
RegistrationId: 0,
UnitId: String,
ProductName: String,
CellDeviceId: String,
DeviceSerialNumber: String,
PhoneNumber: String,
BrandName: String,
ProfileId: 0,
CellularDeviceStateId: 0,
CreateDateTime: 0001-01-01,
LastUpdatDateTime: 0001-01-01,
ContactEmail: String,
Id: 0,
TotalNumberOfRecords: 0
},
Subscription:
{
AccountHolderId: 0,
RegistrationId: 0,
UnitId: String,
SubscriptionStatusTypeId: 0,
BrandId: 0,
StartDate: 0001-01-01,
PreviousBillDate: 0001-01-01,
CurrentBillDate: 0001-01-01,
NextBillDate: 0001-01-01,
PaidUntil: 0001-01-01,
NumberOfOccurrences: 0,
BillingInterval: 0,
BillingIntervalTimeUnitId: 0,
TrialOccurrences: 0,
TrialBillingInterval: 0,
TrialBillingIntervalTimeUnitId: 0,
SubscriptionBillingStatusId: 0,
Id: 0
},
TotalNumberOfRecords: 0
},
TotalNumberOfRecords: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
StartIndex: 0,
NumberOfRecords: 0,
BrandIds:
[
0
],
TransactionStatusIds:
[
0
]
}