PayPoint
  1. Schemas
PayPoint
  • API Access Token
    • Retrieve Access Token
  • Pre-Paid Airtime Reload
    • Lookup Mobile Number Products
    • Fetch Airtime Transaction Receipts
    • Recharge Mobile Number
    • Fetch Latest Transaction
    • Lookup Mobile Number Products
    • Get Airtime Transaction Receipts
    • Get Transaction
    • Get Latest Transaction
    • Get All Products
    • Get Product Sku By Product ID
    • Get All Product Skus
    • Get Product Sku By ID
    • Get All Products By Operator Id
    • Get All Products By Country Code
  • Pay TV Subscription Payments
    • Fetch PayTV Transaction Receipts
    • Pay TV Subscription
    • Fetch Latest Pay TV Transaction
    • Lookup Pay TV Account
    • Get PayTV Transaction Receipts
    • Get Pay TV Transaction
    • Get Latest Pay TV Transaction
    • Lookup Pay TV Account
    • Lookup Pay TV Account Copy
  • Energy Voucher Purchase
    • Fetch Energy Transaction Receipts
    • Fetch Latest Energy Voucher Transaction
    • Purchase Energy Voucher
    • Lookup Energy Bill Payer Account
    • Get Energy Transaction Receipts
    • Get Energy Voucher Transaction
    • Get Latest Energy Voucher Transaction
    • Lookup Energy Bill Payer Account
  • Bill Presentation and Payments - Bill Payments
    • Get Customer Paid Bills
    • Pay Bill
    • Pre-Pay Bill Validation
    • Get Payment Details
  • Bill Presentation and Payments - Bill Charges
    • Calculate Bill Charges
  • Bill Presentation and Payments - Billers
    • Search Billing Company Details
    • Search Billing Company Details
    • Get Billing Company Details By Id
  • Bill Presentation and Payments - Bill Subscription
    • Subscribe to a Bill
    • Cancel Bill Subscription
  • Bill Presentation and Payments - Bill Enquiry
    • Search Bills By Search Criteria
    • Search Bill By Query Parameters
  • Schemas
    • Schemas
      • AccountBillTransactionReceiptCriteria
      • InstantFilter
      • StringFilter
      • Cause
      • ErrorResponse
      • BillPaymentDetail
      • BillPaymentOrderReceipt
      • BillPaymentReceiptResponse
      • EntityProfile
      • ItemPagination
      • ProductDetail
      • BillPayment
      • BillPaymentRequest
      • BillPaymentResponse
      • AccountNumberLookupRequest
      • AccountDetails
      • AccountResponse
      • EBPPBillPaymentResponse
      • AdditionalDataDetails
      • ChargeDetails
      • EBPPBillPaymentDetails
      • EBPPBillPaymentRequest
      • EBPPBillValidateResponse
      • EBPPCalculateBillChargesResponse
      • BillDetail
      • EBPPCalculateBillChargesRequest
      • AdditionalDataRequired
      • BillCompanyBasicDetail
      • EBPPBillerDetailsResponse
      • GenericLink
      • TransactionLinks
      • EBPPBillCompanyDetailSearchCriteria
      • EBPPBillSubscriptionRequest
      • AllowedSourceId
      • Bill
      • BillAccount
      • BillCompanyDetail
      • BillCustomerEntity
      • EBPPBillEnquiryResponse
      • EBPPBillEnquirySearchCriteria
      • SimInformation
      • TopUpDetail
      • TopUpOrderReceipt
      • TopUpReceiptsResponse
      • TopUp
      • TopUpRequest
      • TopUpResponse
      • MobileNumberLookupRequest
      • TopUpProduct
      • TopUpProductLookUpResponse
      • TopUpSku
      • EBPPPaymentHistoryResponse
      • PaymentHistoryDetail
      • DenominationRange
      • RechargeBundleProduct
      • RechargeBundleProductSku
      • RechargeProductCatalogueResponse
      • RechargeProductCatalogueSkuResponse
  1. Schemas

Bill

{
    "billCustomerEntity": {
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "identityNumber": "string",
        "taxNumber": "string",
        "vatNumber": "string",
        "email": "string",
        "contactNumber": "string",
        "comments": "string",
        "customerReference": "string"
    },
    "billCompanyDetail": {
        "id": "1",
        "companyCode": "550001",
        "billerCode": "550001",
        "companyDescription": "Airtel",
        "serviceProvided": "TELECOM",
        "serviceProvidedDescription": "Mobile",
        "category": "POSTPAID",
        "categoryDescription": "Post paid",
        "subCategory": "2GBDownload",
        "subCategoryDescription": "2GB per day",
        "furtherSubCategory": "Plan1299",
        "furtherSubCategoryDescription": "Plan 1299",
        "amountInputMethod": "CUSTOMER-ENTERED",
        "supportedCurrency": "EUR",
        "isPartialAllowed": false,
        "minimumAmountAllowed": 100,
        "isExcessAllowed": false,
        "maxAmountAllowed": 100,
        "additionalDataRequired": [
            {
                "fieldName": "BILLALPHA1",
                "fieldType": "ALPHANUMERIC",
                "isMandatory": false,
                "fieldDescription": "Consumer No"
            }
        ],
        "lastAmendedDate": "2019-08-24",
        "allowedSourceId": [
            {
                "source": "BRANCH-TELLER"
            }
        ]
    },
    "billDetail": {
        "currency": "string",
        "id": "1",
        "customerIdWithBiller": "GT5482AB",
        "reference": "C4920F94022",
        "amount": 12.99,
        "minimumAmount": 12.99,
        "maximumAmount": 12.99,
        "dueDate": "2019-08-24",
        "additionalData": [
            {
                "custom-fields": {
                    "property1": "string",
                    "property2": "string"
                }
            }
        ]
    },
    "billAccount": {
        "accountHolderName": "string",
        "nickname": "string",
        "accountReference": "string",
        "clientIdNumber": "string",
        "currencyCode": "string",
        "accountNumber": "string",
        "currentBalance": 0,
        "currentStatementBalance": 0,
        "minimumPaymentDue": 0,
        "pastAmountDue": 0,
        "nexPaymentDueDate": "2019-08-24T14:15:22Z",
        "statementDate": "2019-08-24T14:15:22Z",
        "payoffAmount": 0,
        "payoffExpiryDate": "2019-08-24T14:15:22Z",
        "organisationName": "string",
        "organisationId": "string",
        "status": "string"
    }
}
Built with