Menu

Developer Resources

  • All Files

BillPay Element

Expand/Collapse All

The BillPay element contains detailed payment information for the service provider and recipient.

ClosedServiceProvider Element

The ServiceProvider element provides information about the company receiving payment to provide a service.

ClosedBillType

Data Type: String

Required For: Bill Pay

Description: The type of service billed by the service provider company.

Possible Values:

Utility_Water

Utility_Electricity

Utility_Gas

Utility_Waste

Utility_Sewage

Communication_Internet

Communication_TV

Communication_MobilePhone

Communication_HomePhone

Communication_Entertainment

Housing_Rent

Housing_Mortgage

Tickets_TollRoads

Tickets_Bus

Tickets_Rental

Government

Other

ClosedCompanyName

Data Type: String

Required For: Bill Pay

Description: The name of the service provider company.

ClosedAddressLine1

Data Type: String

Required For: Bill Pay

Description: The first line in the address for the service provider company.

ClosedAddressLine2

Data Type: String

Required For: Bill Pay

Description: The second line in the address for the service provider company.

ClosedUnitNumber

Data Type: String

Required For: Bill Pay

Description: For non-U.S. addresses, the unit number in the address for the service provider company.

ClosedBuildingNumber

Data Type: String

Required For: Bill Pay

Description: For non-U.S. addresses, the building number in the address for the service provider company.

ClosedStreetOrBlock

Data Type: String

Required For: Bill Pay

Description: For non-U.S. addresses, the street or block in the address for the service provider company.

ClosedNeighborhood

Data Type: String

Required For: Bill Pay

Description: For non-U.S. addresses, the neighborhood name in the address for the service provider company.

ClosedCity

Data Type: String

Required For: Bill Pay

Description: The city in the address for the service provider company.

ClosedRegion

Data Type: String

Required For: Bill Pay

Description: For U.S. addresses, the two-state character code in the address for the service provider company. For non-U.S. addresses, the name of the region.

ClosedPostalCode

Data Type: String

Required For: Bill Pay

Description: The local postal (ZIP) code in the address for the service provider company.

ClosedCountryCode

Data Type: String

Required For: Bill Pay

Description: The country in the address for the service provider company. Use two-character alpha ISO 3166-1 codes.

ClosedPhoneNumber

Data Type: String

Required For: Bill Pay

Description: The phone number for the service provider company. Use zero-padded, 15-digit string without spaces or non-digit characters and include the country code (modified E.163 format).

ClosedInvoiceID

Data Type: String

Required For: Bill Pay

Description: The identification number of the invoice issued by the service provider company.

ClosedServiceRecipient Element

The ServiceRecipient element provides information about the recipient providing payment to receive a service.

ClosedFirstName

Data Type: String

Required For: Bill Pay

Description: The first (given) name for the recipient of the service.

ClosedLastName

Data Type: String

Required For: Bill Pay

Description: The last (surname) name for the recipient of the service.

ClosedAddressLine1

Data Type: String

Required For: Bill Pay

Description: The first line in the address for the recipient of the service.

ClosedAddressLine2

Data Type: String

Required For: Bill Pay

Description: The second line in the address for the recipient of the service.

ClosedUnitNumber

Data Type: String

Required For: Bill Pay

Description: For non-U.S. addresses, the unit number in the address for the recipient of the service.

ClosedBuildingNumber

Data Type: String

Required For: Bill Pay

Description: For non-U.S. addresses, the building number in the address for the recipient of the service.

ClosedStreetOrBlock

Data Type: String

Required For: Bill Pay

Description: For non-U.S. addresses, the street or block in the address for the recipient of the service.

ClosedNeighborhood

Data Type: String

Required For: Bill Pay

Description: For non-U.S. addresses, the neighborhood name in the address for the recipient of the service.

ClosedCity

Data Type: String

Required For: Bill Pay

Description: The city in the address for the recipient of the service.

ClosedRegion

Data Type: String

Required For: Bill Pay

Description: For U.S. addresses, the two-state character code in the address for the recipient of the service. For non-U.S. addresses, the name of the region.

ClosedPostalCode

Data Type: String

Required For: Bill Pay

Description: The local postal (ZIP) code in the address for the recipient of the service.

ClosedCountryCode

Data Type: String

Required For: Bill Pay

Description: The country in the address for the recipient of the service. Use two-character alpha ISO 3166-1 codes.

ClosedAccount Element

The Account element provides information about the service recipient’s account paying the bill to the service provider company.

ClosedOustandingBalance

Data Type: Currency

Required For: Bill Pay

Description: The outstanding balance amount in the service recipient's account.

ClosedIsInGoodStanding

Data Type: Boolean + NULL

Required For: Bill Pay

Description: Indicates if the service recipient's account is in good standing.

Possible Values:

FALSE - The account is not in good standing.

TRUE - The account is in good standing.

NULL or empty value - Nothing is returned.

ClosedLastPaidDate

Data Type: Date

Required For: Bill Pay

Description: The date the last bill was paid by the service recipient. Use Standard ISO 8601 date format: YYYY-MM-DD.

ClosedAgeDays

Data Type: Integer

Required For: Bill Pay

Description: The length of time the service recipient's account has existed.