{
"data": {
"service_id": 1000,
"service_name": "We Home Internet Bills",
"integration_steps": [
{
"step_number": 1,
"step_name": "Inquiry",
"url": "bills/payments/inquiry",
"http_method": "POST",
"input_parameters": [
{
"validations": {
"is_required": true,
"scale": null,
"min_value": null,
"max_value": null,
"min_length": 10,
"max_length": 10,
"starts_with": [
"02",
"03",
"045",
"046",
"013",
"015",
"016",
"028",
"040",
"043",
"047",
"048",
"049",
"050",
"055",
"057",
"062",
"063",
"064",
"065",
"068",
"0663",
"082",
"084",
"086",
"088",
"0693",
"093",
"0952",
"096",
"0972"
],
"is_numeric": true
},
"key": "account_number",
"type": "String",
"description": "The account number provided by the user facilitates bill inquiries and payments like(phone number ,landline ,etc..)"
},
{
"validations": {
"is_required": true,
"scale": null,
"min_value": null,
"max_value": null,
"min_length": 3,
"max_length": 3,
"starts_with": null,
"is_numeric": null
},
"key": "foreign_currency_code",
"type": "String",
"description": "ISO currency code of the foreign currency applied on the request"
}
],
"output_parameters": [
{
"key": "account_number",
"type": "String",
"description": "The account number provided by the user facilitates bill inquiries and payments like(phone number ,landline ,etc..)"
},
{
"key": "balad_reference_number",
"type": "Int",
"description": "Reference number that uniquely identify bill item"
},
{
"key": "amount_egp",
"type": "Decimal",
"description": "Amount of bill to be inquiry or paid in egyptian currency"
},
{
"key": "fees_egp",
"type": "Decimal",
"description": "Fees of the inquiry request/bill"
},
{
"key": "total_amount_egp",
"type": "Decimal",
"description": "Total amount of the inquired request and to be paid in egyptian currency"
},
{
"key": "foreign_amount",
"type": "Decimal",
"description": "Amount of bill to be inquiry or paid in foreign currency"
},
{
"key": "partner_foreign_fees",
"type": "Decimal",
"description": "Partner applied fees in foreign currency"
},
{
"key": "total_foreign_amount",
"type": "Decimal",
"description": "Total amount of the inquiries request and to be paid in foreign currency"
},
{
"key": "foreign_currency_code",
"type": "String",
"description": "ISO currency code of the foreign currency applied on the request"
},
{
"key": "display_message",
"type": "String",
"description": "Description message of the request"
},
{
"key": "is_fees_calculated",
"type": "Boolean",
"description": "Flag represents if the fees is calculated for the request"
}
]
},
{
"step_number": 2,
"step_name": "Fees",
"url": "bills/payments/fees",
"http_method": "POST",
"input_parameters": [
{
"validations": {
"is_required": true,
"scale": null,
"min_value": null,
"max_value": null,
"min_length": null,
"max_length": null,
"starts_with": null,
"is_numeric": null
},
"key": "balad_reference_number",
"type": "Int",
"description": "Reference number that uniquely identify bill item"
}
],
"output_parameters": [
{
"key": "account_number",
"type": "String",
"description": "The account number provided by the user facilitates bill inquiries and payments like(phone number ,landline ,etc..)"
},
{
"key": "balad_reference_number",
"type": "Int",
"description": "Reference number that uniquely identify bill item"
},
{
"key": "amount_egp",
"type": "Decimal",
"description": "Amount of bill to be inquiry or paid in egyptian currency"
},
{
"key": "fees_egp",
"type": "Decimal",
"description": "Fees of the inquiry request/bill"
},
{
"key": "total_amount_egp",
"type": "Decimal",
"description": "Total amount of the inquired request and to be paid in egyptian currency"
},
{
"key": "foreign_amount",
"type": "Decimal",
"description": "Amount of bill to be inquiry or paid in foreign currency"
},
{
"key": "partner_foreign_fees",
"type": "Decimal",
"description": "Partner applied fees in foreign currency"
},
{
"key": "total_foreign_amount",
"type": "Decimal",
"description": "Total amount of the inquiries request and to be paid in foreign currency"
},
{
"key": "foreign_currency_code",
"type": "String",
"description": "ISO currency code of the foreign currency applied on the request"
},
{
"key": "display_message",
"type": "String",
"description": "Description message of the request"
},
{
"key": "is_fees_calculated",
"type": "Boolean",
"description": "Flag represents if the fees is calculated for the request"
},
{
"key": "amount_in_cash",
"type": "Decimal",
"description": "Amount paid by customer in cash"
}
]
},
{
"step_number": 3,
"step_name": "Confirm Payment",
"url": "bills/payments/confirm",
"http_method": "POST",
"input_parameters": [
{
"validations": {
"is_required": true,
"scale": null,
"min_value": null,
"max_value": null,
"min_length": null,
"max_length": null,
"starts_with": null,
"is_numeric": null
},
"key": "balad_reference_number",
"type": "Int",
"description": "Reference number that uniquely identify bill item"
}
],
"output_parameters": [
{
"key": "account_number",
"type": "String",
"description": "The account number provided by the user facilitates bill inquiries and payments like(phone number ,landline ,etc..)"
},
{
"key": "balad_reference_number",
"type": "Int",
"description": "Reference number that uniquely identify bill item"
},
{
"key": "amount_egp",
"type": "Decimal",
"description": "Amount of bill to be inquiry or paid in egyptian currency"
},
{
"key": "fees_egp",
"type": "Decimal",
"description": "Fees of the inquiry request/bill"
},
{
"key": "total_amount_egp",
"type": "Decimal",
"description": "Total amount of the inquired request and to be paid in egyptian currency"
},
{
"key": "foreign_amount",
"type": "Decimal",
"description": "Amount of bill to be inquiry or paid in foreign currency"
},
{
"key": "partner_foreign_fees",
"type": "Decimal",
"description": "Partner applied fees in foreign currency"
},
{
"key": "total_foreign_amount",
"type": "Decimal",
"description": "Total amount of the inquiries request and to be paid in foreign currency"
},
{
"key": "foreign_currency_code",
"type": "String",
"description": "ISO currency code of the foreign currency applied on the request"
},
{
"key": "display_message",
"type": "String",
"description": "Description message of the request"
},
{
"key": "is_fees_calculated",
"type": "Boolean",
"description": "Flag represents if the fees is calculated for the request"
},
{
"key": "transaction_number",
"type": "String",
"description": "Unique identifier of the created transaction on balad"
},
{
"key": "transaction_time",
"type": "DateTime",
"description": "Time of the created transaction on balad"
},
{
"key": "powered_by",
"type": "String",
"description": "The service provider powering the payment"
},
{
"key": "reference_number",
"type": "String",
"description": "Reference number that created on the service provider powering the payment"
},
{
"key": "amount_in_cash",
"type": "Decimal",
"description": "Amount paid by customer in cash"
}
]
}
]
},
"errors": null
}
