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 "Authorization: GLOREMIT <UID>:<PWD>:<rspSign>"
Request Description
Parameter Name | Required | Min/Max Length | Type | Remark |
UID | M | 5/50 | Alphanumeric | Username for validation. |
PWD | M | 5/50 | Alphanumeric | Password for validation, 3DES encrypted. |
rspSign | M | 32/50 | Alphanumeric | Digital signature of RSP. (Please refer to Digital signature) |
transID | M | 6/16 | Alphanumeric | 6 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. |
sFirstName | M | 1/100 | Alphanumeric | Sender’s first name. (max 100 characters) |
sLastName | M | 1/100 | Alphanumeric | Sender’s last name. (max 100 characters) |
sIdType | O | 1/30 | Numeric | Sender Identification Type. (Please refer to Sender) |
sIdNum | O | 8/16 | Alphanumeric | Sender Identification Number. |
bCountry | M | 2/5 | Alphanumeric | Bill country code. Accept ISO 3166-1 Alpha-2 ONLY (Please refer to ISO 3166 Country Code) |
bCurrency | M | 3/6 | Alphanumeric | Bill Currency Code. (Please refer to ISO 4217 Currency Code) |
bAmount | M | 1/16 | Numeric | Total amount to pay for the bill. |
bIssuerCode | M | 3/16 | Alphanumeric | Biller Issuer Code. (Please refer to Service Spec) |
bAccNum | M | 1/18 | Alphanumeric | Bill 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 Name | Required | Type | Remark |
InquiryStatus | M | Numeric | Transaction request status response code. (Please refer to Transaction status) |
transID | M | Alphanumeric | Unique Transaction ID from RSP. |
Description | M | Alphanumeric | Transaction description or advice. |
AccountName | O | Alphanumeric | The bill account holder name as returned by account issuer/biller. |
StatementDate | O | Alphanumeric | Bill Statement Date. Date Format: MM/dd/YYYY |
DueDate | O | Alphanumeric | Bill Statement Due Date. Date Format: MM/dd/YYYY |
Amount | O | Alphanumeric | Bill Statement Amount in bCurrency. |
BillType | O | Alphanumeric | Bill Type. |
CustomInfo1 | O | Alphanumeric | Bill Custom Information 1. |
CustomInfo2 | O | Alphanumeric | Bill Custom Information 2. |
CustomInfo3 | O | Alphanumeric | Bill Custom Information 3. |
CustomInfo4 | O | Alphanumeric | Bill Custom Information 4. |
CustomInfo5 | O | Alphanumeric | Bill Custom Information 5. |
CustomInfo6 | O | Alphanumeric | Bill Custom Information 6. |
CustomInfo7 | O | Alphanumeric | Bill Custom Information 7. |
CustomInfo8 | O | Alphanumeric | Bill Custom Information 8. |
CustomInfo9 | O | Alphanumeric | Bill Custom Information 9. |
CustomInfo10 | O | Alphanumeric | Bill Custom Information 10. |
M= Mandatory, C= Conditional, O= Optional