Response Objects for Server-Side
This page lists objects returned in response to server-side calls.
AccountGroupCreateResponse
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroupCreateResult | AccountGroupCreateResult | Object containing the result of account group creation. |
AccountGroupCreateResult
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroupInfo | AccountGroupInfo | Object containing information on an account group. |
AccountGroupInfo
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroupId | Integer | Unique integer identifying the account group. |
| AccountGroupName | String | User-specified name for the account group. |
| AccountGroupToken | String | Unique string, identifying the account group, system-allocated at creation-time. |
| CreatedDate | DateTime | Date and time at which the account group was created. |
| EmailAddressDomains | ArrayOfEmailAddressDomain | Array of objects containing email addresses of account group members. |
| IPAddresses | ArrayOfIPAddress | Array of objects containing IP addresses associated with account group members. |
| LastUpdatedDate | DateTime | Date and time at which the account group was last updated. |
| MatchEmailsOnlyAfterIPMatch | Boolean | Whether email addresses should be matched only after successful matching of IP addresses. True means that this condition should apply. |
| Payee | PayeeAccount | Object containing details of the account of the payee for the account group. |
| PermitUserPayment | Boolean | Whether to permit payments for services associated with the account group to come from members other than the listed payee. True means that such payments should be permitted. |
ArrayOfEmailAddressDomain
| Parameter | Data Type | Description |
|---|---|---|
| EmailAddressDomain | EmailAddressDomain array | Object featuring information on email address domains. |
EmailAddressDomain
| Parameter | Data Type | Description |
|---|---|---|
| AffiliateId | Integer | Unique integer that identifies the client. |
| EmailAddressDomain | String | Email address of an account group member. |
ArrayOfIPAddress
| Parameter | Data Type | Description |
|---|---|---|
| ArrayOfIPAddress | IPAddress array | Object featuring information on IP addresses. |
IPAddress
| Parameter | Data Type | Description |
|---|---|---|
| AffiliateId | Integer | Unique integer identifying the client. |
| EndAddress | String | The end address of an address-range. |
| StartAddress | String | The start address of an address-range. |
PayeeAccount
| Parameter | Data Type | Description |
|---|---|---|
| ClientUserID | String | Unique string identifying the user. |
| EmailAddress | String | Email address of the user. |
| FirstName | String | First name of the user. |
| Surname | String | Last name of the user. |
AccountGroupAddUserResponse
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroupAddUserResult | iPayDeveloperBaseData | Object containing error messages. |
iPayDeveloperBaseData
| Parameter | Data Type | Description |
|---|---|---|
| ErrorMessage | String | An error message. |
| ErrorNumber | String | An error number. |
AccountGroupInfoAllResponse
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroupInfoAllResult | AccountGroupInfoAllResult | An object containing results from a search on account groups. |
AccountGroupInfoAllResult
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroups | ArrayOfAccountGroupInfoSummary | An object containing an array of objects, each of which provides summary information on an account group. |
| CurrentPage | Integer | The current page of the response pages, as requested. |
| TotalPages | Integer | The total number of pages in the response. |
| TotalRows | Integer | The total number of rows per page, as requested. |
ArrayOfAccountGroupInfoSummary
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroupInfoSummary | AccountGroupInfoSummary | An object containing information on an account group. |
AccountGroupInfoSummary
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroupID | Integer | A unique integer identifying the account group. |
| AccountGroupName | String | Name of the account group. |
| SystemAccountFirstName | String | First name of the system administrator handling the account group. |
| SystemAccountId | Integer | Unique integer identifying the system administrator handling the account group. |
| SystemAccountSurname | Integer | Last name of the system administrator handling the account group. |
| SystemAccountUsername | String | Username of the system administrator handling the account group. |
AccountGroupSubscriptionsInfoResponse
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroupSubscriptionsInfoResult | UserServicesResult | An object containing information on subscriptions associated with an account group. |
UserServicesResult
| Parameter | Data Type | Description |
|---|---|---|
| UserServicesResult | UserServicesResultData | An object containing service-information. |
UserServicesResultData
| Parameter | Data Type | Description |
|---|---|---|
| UserServicesResultData | ServiceInformation | An object containing information service-information. |
ServiceInformation
| Parameter | Data Type | Description |
|---|---|---|
| ServiceInformation | ServiceInformationResultData | An object containing information on a service. |
ServiceInformationResultData
| Parameter | Data Type | Description |
|---|---|---|
| ApplicationMessage | String | Information recorded by the application used to offer the service. |
| ApplicationMessage2 | String | Additional information recorded by the application used to offer the service. |
| ApplicationOfferName | String | User-facing name used to offer the service. |
| ExpiryDateUTC | dateTime | The UTC date and time at which the service is currently set to expire. |
| FirstNonDiscountedBillingPointUTC | dateTime | The UTC date and time of the first non-discounted billing-point scheduled for the service. |
| LastDiscountedBillingPointUTC | dateTime | The UTC date and time of the last discounted billing-point scheduled for the service. |
| OfferName | String | System-internal name of the offer. |
| OfferTypeId | String | Identifier for the offer. |
| PaymentMethod | String | Payment method for the offer. |
| PaymentScheduleInformation | PaymentScheduleResult | Object containing information on the payment-schedule for the service. |
| ProductParameters | ArrayOfServiceInfoProductParameter | Object itself containing an array of objects, each of which contains information on service product-parameters. |
| ServiceGroup | String | Service-group for the service. |
| ServiceID | Integer | Unique identifier for the service. |
| ServiceStatus | String | Status of the service. |
| ServiceTitle | String | Title of the service. |
| SubscriptionInformation | SubscriptionResult | Object containing subscription-information. |
| VoucherCode | String | Code of the voucher associated with the service. |
| VoucherDiscountPrice | Decimal | Discount price associated with the voucher. Required only if VoucherCode is specified. |
PaymentScheduleResult
| Parameter | Data Type | Description |
|---|---|---|
| PaymentScheduleResult | PaymentScheduleResult | An instance of the PaymentScheduleResultData object, which contains information on a payment schedule. |
PaymentScheduleResultData
| Parameter | Data Type | Description |
|---|---|---|
| Currency | Currency | An object specifying currency options. |
| Frequency | String | Frequency of payments. |
| PaymentDateOffset | Integer | Offset for the specified payment date. |
| PaymentDateUTC | Integer | Scheduled payment date. |
| ScheduleOrders | ArrayOfScheduledOrdersResult | Array of objects containing schedule orders. |
| StartDateUTC | dateTime | Start date of the payment schedule, in UTC format. |
| TotalAmount | Decimal | Total amount to be paid for the schedule. |
ArrayOfScheduledOrdersResult
| Parameter | Data Type | Description |
|---|---|---|
| ScheduledOrdersResult | ScheduledOrdersResult | An object containing information on schedule orders. |
ScheduledOrdersResult
| Parameter | Data Type | Description |
|---|---|---|
| ScheduledOrdersResult | ScheduledOrdersResult | An instance of the ScheduledOrdersResultData object, which contains information on schedule orders. |
ScheduledOrdersResultData
| Parameter | Data Type | Description |
|---|---|---|
| Currency | Currency | An object specifying currency options. |
| OrderDateUTC | dateTime | The date of the order. |
| OrderId | Integer | Unique identifer for the order. |
| OrderStatus | OrderStatus | Object containing information on order-status. |
| PaymentMethod | String | Method of payment for the order. |
| PriceInformation | TaxResult | Object containing information on pricing. |
Currency
| Parameter | Data Type | Description |
|---|---|---|
| Currency | Currency | One of the following string-literals: ZZZ, GBP, EUR, USD, AUD, CAD, SEK, DKK, JPY, MPPCREDITS, SAR, BGN, TWD, CZK, ILS, HUF, ISK, KRW, NOK, PLN, BRL, CHF, RON, RUB, HRK, ALL, THB, TRY, P0KR, IDR, UAH, BYR, EEK, LVL, LTL, TJS, IRR, VND, AMD, AZN, MKD, ZAR, GEL, INR, MYR, KZT, KGS, KES, TMT, UZS, MNT, CNY, KHR, LAK, SYP, LKR, ETB, NPR, AFN, PHP, MVR, NIO, BOB, CLP, NZD, GTQ, RWF, XOF, IQD, MXN, CSD, BND, BDT, DZDE, EGP, HKD, PEN, LYD, SGD, BAM, MOP, CRC, MAD, PAB, TND, DOP, OMR, JMD, VEB, YER, COP, RSD, BZD, JOD, TTD, ARS, LBP, ZWL, KWD, AED, UYU, BHD, PYG, QAR, HNL. |
OrderStatus
| Parameter | Data Type | Description |
|---|---|---|
| OrderStatus | OrderStatus | One of the following string-literals: Created, New, Confirmed, Dispatched, Cancelled, Notified, Reminder, Completed, Refunded, Waiting, Downloaded, SuspectedDuplicate, MaxRefunded, PartialRefunded, NeedToOrder, ProductsOrdered, Authorised. |
TaxResult
| Parameter | Data Type | Description |
|---|---|---|
| GrossAmount | Decimal | The total pre-tax cost of the order. |
| NetAmount | Decimal | The total post-tax cost of the order. |
| TaxRegions | ArrayOfTaxRegionAmountResult | An object containing information on tax regions. |
| TotalTaxAmount | Decimal | The total tax amount for the order. |
| TotalTaxPercentage | Decimal | The total tax percentage for the order. |
ArrayOfTaxRegionAmount
| Parameter | Data Type | Description |
|---|---|---|
| ArrayOfTaxRegionAmount | TaxRegionAmount | One or more instances of an object containing information on a tax region amount. |
TaxRegionAmount
| Parameter | Data Type | Description |
|---|---|---|
| DisplayName | String | Display name for the tax region; which is the country, state, county, city, or other geographical area to which the tax applies. See the section Taxes for more information on tax-related definitions. |
| TaxAmountForRegion | Decimal | Tax amount for the specified tax-region. |
| TaxCategory | String | Category of the tax region. This may be Standard, which is the default; or the name of a custom-category, selected by the client. |
| TaxRateForRegion | Decimal | Tax rate for the specified tax-region. |
AccountGroupUsersResponse
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroupUsersResult | AccountGroupUsersResult | An object containing information on account group users. |
AccountGroupUsersResult
| Parameter | Data Type | Description |
|---|---|---|
| Accounts | ArrayOfAccount | An array of objects containing information on accounts. |
| CurrentPage | Integer | Current page of returned multiplicity. |
| TotalPages | Integer | Total number of pages of account-data returned. |
| TotalRows | Integer | Maximum number of rows per page of account-data returned. |
ArrayOfAccount
| Parameter | Data Type | Description |
|---|---|---|
| Account | Account | Objects each of which contains information on an account. |
Account
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroupRole | UserRoleType | An object containing information on user-roles within an account group. |
| ClientUserID | String | Unique identifier for the user. Must be specified if no EmailAddress is specified. |
| EmailAddress | String | Email address of the user. Must be specified if no ClientUserID is specified. |
| FirstName | String | First name of the user. |
| Surname | String | Last name of the user. |
UserRoleType
| Parameter | Data Type | Description |
|---|---|---|
| UserRoleType | UserRoleType | One of the following string-literals: Unspecified, User, Payee, Admin. |
UserAccountGroupsResponse
| Parameter | Data Type | Description |
|---|---|---|
| UserAccountGroupsResult | UserAccountGroupsResult | An object containing information on a user's account groups. |
UserAccountGroupsResult
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroups | ArrayOfUserAccountGroup | An array of objects, each containing information on a user's account group. |
ArrayOfUserAccountGroup
| Parameter | Data Type | Description |
|---|---|---|
| UserAccountGroup | UserAccountGroup | An object containing information on a user's account group. |
UserAccountGroup
| Parameter | Data Type | Description |
|---|---|---|
| AccountGroup | AccountGroupInfo | An object containing information on an account group. |
| UserRole | UserRoleType | An object containing information on the type of account group role of the user. |