Bills: Bill Inquiry

Partner use this method to retrieve information of a bill account. This method is limited only to certain billers (Please refer to GloRemit API Code List). By providing the bill account number together with the biller code, GloRemit will return the information such as account name, amount due and other relevant information. However the availability of the information is dependent on the biller’s response.

Definition:

GET /v1/payments/bills/requests/{transID}?sIdType={sIdType}&sIdNum={sIdNum}&sFirstName={sFirstName}&sLastName={sLastName}&bCountry={bCountry}&bCurrency={bCurrency}&bAmount={bAmount}&bIssuerCode={bIssuerCode}&bAccNum={bAccNum}


Sample Request:

curl -v "http://staging-gloremit.tranglo.com:2014/v1/payments/bills/requests/1208?sIdType=1
&sIdNum=710320-71-5379&sFirstName=Kai&sLastName=Yen&bCountry=PH&bCurrency=PHP&bAmount=200
&bIssuerCode=61161&bAccNum=1111" \
-H "AuthorizationGLOREMIT <UID>:<PWD>:<rspSign>"

Request Description

Parameter NameRequiredMin/Max LengthTypeRemark
UIDM5/50AlphanumericUsername for validation.
PWDM5/50AlphanumericPassword for validation, 3DES encrypted.
rspSignM32/50AlphanumericDigital signature of RSP.
(Please refer to Digital signature)
transIDM6/16Alphanumeric6 digits or more unique transaction ID from RSP.
If the same transID were used, the system will validate against the transaction details.
* The new request with DIFFERENT transaction details will be rejected with error duplicate transID, Else system will respond the same as per first request.
sFirstNameM1/100AlphanumericSender’s first name.
(max 100 characters)
sLastNameM1/100AlphanumericSender’s last name.
(max 100 characters)
sIdTypeO1/30NumericSender Identification Type.
(Please refer to Sender)
sIdNumO8/16AlphanumericSender Identification Number.
bCountryM2/5AlphanumericBill country code.
Accept ISO 3166-1 Alpha-2 ONLY
(Please refer to ISO 3166 Country Code)
bCurrencyM3/6AlphanumericBill Currency Code.
(Please refer to ISO 4217 Currency Code)
bAmountM1/16NumericTotal amount to pay for the bill.
bIssuerCodeM3/16AlphanumericBiller Issuer Code.
(Please refer to Service Spec)
bAccNumM1/18AlphanumericBill Account Number or any other unique account identifier as determined by biller.

Response Description

GloRemit server will return a JSON format with response code when RSP request is accepted.

Sample Response:

{
    "InquiryStatus":"930",
    "transID":"1208",
    "Description":"Transaction Rejected",
    "AccountName":"null",
    "StatementDate":"01/01/0001",
    "DueDate":"01/01/0001",
    "Amount":"0.00",
    "BillType":"null",
    "CustomInfo1":"null",
    "CustomInfo2":"null",
    "CustomInfo3":"null",
    "CustomInfo4":"null",
    "CustomInfo5":"null",
    "CustomInfo6":"null",
    "CustomInfo7":"null",
    "CustomInfo8":"null",
    "CustomInfo9":"null",
    "CustomInfo10":"null"
}
Parameter NameRequiredTypeRemark
InquiryStatusMNumericTransaction request status response code.
(Please refer to Transaction status)
transIDMAlphanumericUnique Transaction ID from RSP.
DescriptionMAlphanumericTransaction description or advice.
AccountNameOAlphanumericThe bill account holder name as returned by account issuer/biller.
StatementDateOAlphanumericBill Statement Date.
Date Format: MM/dd/YYYY
DueDateOAlphanumericBill Statement Due Date.
Date Format: MM/dd/YYYY
AmountOAlphanumericBill Statement Amount in bCurrency.
BillTypeOAlphanumericBill Type.
CustomInfo1OAlphanumericBill Custom Information 1.
CustomInfo2OAlphanumericBill Custom Information 2.
CustomInfo3OAlphanumericBill Custom Information 3.
CustomInfo4OAlphanumericBill Custom Information 4.
CustomInfo5OAlphanumericBill Custom Information 5.
CustomInfo6OAlphanumericBill Custom Information 6.
CustomInfo7OAlphanumericBill Custom Information 7.
CustomInfo8OAlphanumericBill Custom Information 8.
CustomInfo9OAlphanumericBill Custom Information 9.
CustomInfo10OAlphanumericBill Custom Information 10.

M= Mandatory, C= Conditional, O= Optional