GetPaymentGroups

Description

This command returns the full information for a payment group and it's associated gateways. It does not get the config parameters for the gateways, only the info in the conf group table like ID and display name. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetPaymentGroups command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Mark Garrett

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<paymentGroupID><!-- int --></paymentGroupID>
			<paymentGroupName><!-- string --></paymentGroupName>
			<paymentGroupCurrencyID><!-- string --></paymentGroupCurrencyID>
			<sortDir><!-- None --></sortDir>
			<sortColumn><!-- None --></sortColumn>
			<recordOffset><!-- None --></recordOffset>
			<numRecords><!-- None --></numRecords>
		</params>
	</mbapi>

		

Example Response

None
		

Request Elements

mbapi
Type
None
Description
None
Children
command
Type
None
Description
None
showXMLHeader
Type
None
Description
None
params
Type
None
Description
None
Children
paymentGroupID
Type
int
Description

The ID of the payment group to fetch. This will always select at most 1 payment.

paymentGroupName
Type
string
Description

The name of the payment group to fetch. This will retrieve with a LIKE statement

paymentGroupCurrencyID
Type
string
Description

The 3 character ISO 4217 currency code that this payment groups uses

sortDir
Type
None
Description
None
sortColumn
Type
None
Description
None
recordOffset
Type
None
Description
None
numRecords
Type
None
Description
None

Response Elements

None