Skip to main content

Bill Payment

The Bill Payment API enables to process domestic electronic bill payments through RPPS (Remote Payment and Presentment Service).

Method: POST​

{{localCEUrl}}/analytics/rest/eventApi/event

Headers​

NameValue
Content-Typeapplication/json

Example​

Payload Parameters
ParameterDescription

InstructionIdentification

Mandatory

String

Unique identifier of the payment instruction

Example – "f9a820da-7bcd-4941-b85c-201169ccf41a"

EndToEndIdentification

Optional

String

Unique identifier to track the transaction any time during the process

Example – "31fe4401-d804-441e-b67a-44016b99b08f"

Reason

Optional

String

Reason or purpose given for the transaction

Example – "Loan Repayment"

Channel

Optional

String

Channel through which the transaction happens

Example – "WIRE"

TransactionType

Optional

String

Type of transaction

Example – "BILLPAY"

TransactionCode

Optional

String

Specific code for the transaction type

Example – "BILLPAY_RPPS"

Source

Optional

String

Name of the source system from where the payment request is initiated

Example – "LEDGER"

TransactionAmount

Mandatory

Object

Amount

Mandatory

String

Amount of the transaction

Example – "21.00"

Currency

Mandatory

String

Currency type of the transaction amount

Example – "USD"

Debtor

Required

Object

CustomerType

Optional

String

Customer type of the debtor (sender), which can possibly be the ‘Account Holder', ‘Account Holder Business' or ‘TSP'

Example – "ACCOUNT_HOLDER"

UserType

Optional

String

Type of the user based on user-role, which can be ‘Individual' or ‘Legal Rep'

Example – "INDIVIDUAL"

Identification

Optional

String

Individual ID of the debtor

Example – "894100103"

IdentificationType

Optional

String

Type of identification used for individual ID

Example – "SSN"

CustomerNumber

Optional

String

Unique ID provided for the debtor as a customer

Example – "894100103"

InstitutionNumber

Optional

String

Unique ID that identifies the financial institution

Example – "123456789012345"

Name

Required

String

Customer name of the debtor

Example – "Nicholaus Abshire"

NameInFile

Optional

String

Name of the debtor given in the payment instruction

Example – "Nicholaus Abshire"

Gender

Optional

String

Gender of the debtor as a customer

Example – "Male"

DebtorDateOfBirth

Optional

Object

Year

Optional

String

Birth year of the debtor

Example – "1974"

Month

Optional

String

Birth month of the debtor

Example – "05"

Day

Optional

String

Birth year of the debtor

Example – "17"

DateOfBirth

Optional

String

Date of birth of debtor in YYYYMMDD format

Example – "19740517"

DebtorPostalAddress

Optional

Object

AddressType

Optional

String

Address type of debtor

Example – "HOUSE"

AddressLine1

Optional

String

Line 1 of debtor address

Example – "2745 SW VILLA DIRAQ"

AddressLine2

Optional

String

Line 2 of debtor address

Example – "Apt 304"

City

Optional

String

City name of the debtor address

Example – "Kansas City"

State

Optional

String

State of the debtor address

Example – "MO"

ZipCode

Optional

String

Zip code of debtor address location

Example – "66610"

CountryCode

Optional

String

Country code of debtor's country

Example – "840"

Nationality

Optional

String

Nationality of the debtor

Example – "USA"

Country

Optional

String

Country of the debtor's location

Example – "USA"

DebtorContact

Optional

Object

PrimaryEmail

Optional

String

Contact email ID of the debtor

Example – "amazon@gmail.com"

PrimaryPhone

Optional

String

Contact phone number of the debtor

Example – "0016540010002"

DebtorAccount

Optional

Object

AccountNumber

Optional

String

Account number of the debtor

Example – "2001101"

AccountType

Optional

String

Type of the debtor's account

Example – "SAVINGS"

AccountName

Optional

String

Debtor's account name

Example – "GENERAL ACCOUNT"

Institution

Optional

Object

Identification

Optional

String

Identification code of the debtor account financial institution, which is possibly the routing number

Example – "021000018"

IdentificationType

Optional

String

Identification type of the debtor account financial institution

Example – "ABA"

Name

Optional

String

Name of the debtor account financial institution

Example – "Bank Of New York"

DebtorGeoLocation

Optional

Object

Latitude

Optional

String

Geographical latitude of debtor's location

Example – "13.02354160"

Longitude

Optional

String

Geographical longitude of debtor's location

Example – "80.14923669"

Creditor

Required

Object

CustomerType

Optional

String

Customer type of the creditor (receiver), which can possibly be the ‘Account Holder', ‘Non-account Holder', ‘Account Holder Business' or ‘TSP'

Example – "NON_ACCOUNT_HOLDER"

Identification

Optional

String

Individual ID of the creditor

Example – "0000060614"

IdentificationType

Optional

String

Type of identification used for individual ID

Example – "BILLER_ID"

Name

Required

String

Customer name of the creditor

Example – "Public Employees Credit Union"

CreditorAccount

Optional

Object

AccountNumber

Optional

String

Account number of the creditor

Example – "2545647849"

AccountName

Optional

String

Creditor's account name

Example – "BILLER ACCOUNT"

Institution

Optional

Object

Identification

Optional

String

Identification code of the creditor account financial institution, which is possibly the routing number

Example – "021000018"

IdentificationType

Optional

String

Identification type of the creditor account financial institution

Example – "ABA"

Name

Optional

String

Name of the creditor account financial institution

Example – "Bank Of New York"

CreditorPostalAddress

Optional

Object

AddressType

Optional

String

Address type of creditor

Example – "HOUSE"

AddressLine1

Optional

String

Line 1 of creditor address

Example – "3745 SW VENEZULA CUBARD IRANMA"

AddressLine2

Optional

String

Line 2 of creditor address

Example – "Suite C"

City

Optional

String

City name of the creditor address

Example – "Topeka"

State

Optional

String

State of the creditor address

Example – "KS"

ZipCode

Optional

String

Zip code of creditor address location

Example – "66610"

CountryCode

Optional

String

Country code of creditor country

Example – "840"

Country

Optional

String

Country of the creditor's location

Example – "VENEZUALA"

CreditorContact

Optional

Object

PrimaryEmail

Optional

String

Contact email ID of the creditor

Example – "lifetime@lifetime.com"

PrimaryPhone

Optional

String

Contact phone number of the creditor

Example – "0017850010002"

Risk

Optional

Object

MachineFingerPrint

Optional

Object

IpAddress

Optional

String

IP address of the device from which the transaction is initiated

Example – "98.186.126.180"

OperatingSystem

Optional

String

Operating system of the device

Example – "Mac OS"

WebBrowser

Optional

String

Web browser used for transaction

Example – "safari"

Uuid

Optional

String

Unique ID of the device

Example – "7609EFD3-CED4-440F-9C18-D330EE9311FC"

Model

Optional

String

Model of the device

Example – "iPhone"

SystemName

Optional

String

System name of the device

Example – "iOS"

SystemVersion

Optional

String

System version of the operating system

Example – "13.3.1"

PhoneName

Optional

String

User name of the Mobile phone

Example – "My IPHONE"

Imei

Optional

String

Unique 15-digit serial number for identifying a device (International Mobile Equipment Identity)

Example – ""

SessionId

Optional

String

Unique identifier that a web server assigns to a user for the duration of the current session

Example – ""

OperatingSystemFamily

Optional

String

Specific operating system used for transaction belongs to which OS family

Example – "MAC_OS"

OperatingSystemProducer

Optional

String

Manufacturer of the OS

Example – "Apple Computer, Inc."

GeoLocation

Optional

Object

Latitude

Optional

String

Geographical latitude of the location where the transaction occurred

Example – "39.75931104"

Longitude

Optional

String

Geographical longitude of the location where the transaction occurred

Example – "-105.01091174"


curl --location 'http://localhost:8080/BiReport/rest/eventApi/event' \
--header 'Content-Type: application/json' \
--data-raw '{"InstructionIdentification":"f9a820da-7bcd-4941-b85c-201169ccf41a","EndToEndIdentification":"31fe4401-d804-441e-b67a-44016b99b08f","Reason":"Loan Repayment","Channel":"WIRE","TranactionType":"BILLPAY","TranactionCode":"BILLPAY_RPPS","Source":"LEDGER","TransactionAmount":{"Amount":"21.00","Currency":"USD"},"Debtor":{"CustomerType":"ACCOUNT_HOLDER","UserType":"INDIVIDUAL","Identification":"894100103","IdentificationType":"SSN","CustomerNumber":"894100103","InstitutionNumber":"123456789012345","Name":"Nicholaus Abshire","NameInFile":"Nicholaus Abshire","Gender":"Male"},"DebtorDateOfBirth":{"Year":"1974","Month":"05","Day":"17","DateOfBirth":"19740517"},"DebtorPostalAddress":{"AddressType":"HOUSE","AddressLine1":"2745 SW VILLA DIRAQ","AddressLine2":"Apt 304","City":"Kansas City","State":"MO","ZipCode":"66610","CountryCode":"840","Nationality":"USA","Country":" USA "},"DebtorContact":{"PrimaryEmail":"amazon@gmail.com","PrimaryPhone":"0016540010002"},"DebtorAccount":{"AccountNumber":"2001101","AccountType":"SAVINGS","AccountName":"GENERAL ACCOUNT","Institution":{"Identification":"021000018","IdentificationType":"ABA","Name":"Bank Of New York"}},"DebtorGeoLocation":{"Latitude":"13.02354160","Longitude":"80.14923669"},"Creditor":{"CustomerType":"NON_ACCOUNT_HOLDER","Identification":"0000060614","IdentificationType":"BILLER_ID","Name":"Public Employees Credit Union"},"CreditorAccount":{"AccountNumber":"2545647849","AccountName":"BILLER ACCOUNT","Institution":{"Identification":"021000018","IdentificationType":"ABA","Name":"Bank Of New York"}},"CreditorDateOfBirth":{"Year":"1970","Month":"11","Day":"15"},"CreditorPostalAddress":{"AddressType":"HOUSE","AddressLine1":"3745 SW VENEZULA CUBARD IRANMA","AddressLine2":"Suite C","City":"Topeka","State":"KS","ZipCode":"66610","CountryCode":"840","Country":"VENEZUALA"},"Risk":{"MachineFingerPrint":{"IpAddress":"98.186.126.180","OperatingSystem":"Mac OS","WebBrowser":"safari","Uuid":"7609EFD3-CED4-440F-9C18-D330EE9311FC","Model":"iPhone","SystemName":"iOS","SystemVersion":"13.3.1","PhoneName":"My IPHONE","Imei":"","SessionId":"","OperatingSystemFamily":"MAC_OS","OperatingSystemProducer":"Apple Computer, Inc."},"GeoLocation":{"Latitude":"39.75931104","Longitude":"-105.01091174"}}}'

Body​


{
  "InstructionIdentification": "f9a820da-7bcd-4941-b85c-201169ccf41a",
  "EndToEndIdentification": "31fe4401-d804-441e-b67a-44016b99b08f",
  "Reason": "Loan Repayment",
  "Channel": "WIRE",
  "TranactionType": "BILLPAY",
  "TranactionCode": "BILLPAY_RPPS",
  "Source": "LEDGER",
  "TransactionAmount": {
    "Amount": "21.00",
    "Currency": "USD"
  },
  "Debtor": {
    "CustomerType": "ACCOUNT_HOLDER",
    "UserType": "INDIVIDUAL",
    "Identification": "894100103",
    "IdentificationType": "SSN",
    "CustomerNumber": "894100103",
    "InstitutionNumber": "123456789012345",
    "Name": "Nicholaus Abshire",
    "NameInFile": "Nicholaus Abshire",
    "Gender": "Male"
  },
  "DebtorDateOfBirth": {
    "Year": "1974",
    "Month": "05",
    "Day": "17",
    "DateOfBirth": "19740517"
  },
  "DebtorPostalAddress": {
    "AddressType": "HOUSE",
    "AddressLine1": "2745 SW VILLA DIRAQ",
    "AddressLine2": "Apt 304",
    "City": "Kansas City",
    "State": "MO",
    "ZipCode": "66610",
    "CountryCode": "840",
    "Nationality": "USA",
    "Country": " USA "
  },
  "DebtorContact": {
    "PrimaryEmail": "amazon@gmail.com",
    "PrimaryPhone": "0016540010002"
  },
  "DebtorAccount": {
    "AccountNumber": "2001101",
    "AccountType": "SAVINGS",
    "AccountName": "GENERAL ACCOUNT",
    "Institution": {
      "Identification": "021000018",
      "IdentificationType": "ABA",
      "Name": "Bank Of New York"
    }
  },
  "DebtorGeoLocation": {
    "Latitude": "13.02354160",
    "Longitude": "80.14923669"
  },
  "Creditor": {
    "CustomerType": "NON_ACCOUNT_HOLDER",
    "Identification": "0000060614",
    "IdentificationType": "BILLER_ID",
    "Name": "Public Employees Credit Union"
  },
  "CreditorAccount": {
    "AccountNumber": "2545647849",
    "AccountName": "BILLER ACCOUNT",
    "Institution": {
      "Identification": "021000018",
      "IdentificationType": "ABA",
      "Name": "Bank Of New York"
    }
  },
  "CreditorDateOfBirth": {
    "Year": "1970",
    "Month": "11",
    "Day": "15"
  },
  "CreditorPostalAddress": {
    "AddressType": "HOUSE",
    "AddressLine1": "3745 SW VENEZULA CUBARD IRANMA",
    "AddressLine2": "Suite C",
    "City": "Topeka",
    "State": "KS",
    "ZipCode": "66610",
    "CountryCode": "840",
    "Country": "VENEZUALA"
  },
  "Risk": {
    "MachineFingerPrint": {
      "IpAddress": "98.186.126.180",
      "OperatingSystem": "Mac OS",
      "WebBrowser": "safari",
      "Uuid": "7609EFD3-CED4-440F-9C18-D330EE9311FC",
      "Model": "iPhone",
      "SystemName": "iOS",
      "SystemVersion": "13.3.1",
      "PhoneName": "My IPHONE",
      "Imei": "",
      "SessionId": "",
      "OperatingSystemFamily": "MAC_OS",
      "OperatingSystemProducer": "Apple Computer, Inc."
    },
    "GeoLocation": {
      "Latitude": "39.75931104",
      "Longitude": "-105.01091174"
    }
  }
}

Response: 200​

Payload Parameters
ParameterDescription

id

String

ID of the request

Example – "3f425dbd-518b-4fc5-bb8f-77df7ef9ef0c"

jsonrpc

String

JSON-RPC version used for the API

Example – "2.0"

method

String

API method

Example – "ce.event"

result

Object

resp

String

Type of response

Example – "event"

status

String

Status of the event

Example – "1"

riskScore

Number

Estimated Risk score of the transaction

Example – 687

signalScore

Number

Signal reliability score of the transaction

Example – 687

scenarioScore

Number

Score of specific scenarios related to the transaction event

Example – 0

tokenScore

Number

Score of token authentication used in the transaction

Example – 0

categoryScore

Number

Event category score of transaction

Example – 0

ofacConfidentScore

Number

Estimated score of compliance with OFAC regulations

Example – 0

debtorProfileId

String

Unique ID of debtor profile

Example – "9C1C1A87D297C038D71DD1623F03191D"

creditorProfileId

String

Unique ID of creditor profile

Example – "2CED9F48EE3B49D97D9263F1AEAB26D8"

error

Null

Shows information, if any error occurs during transaction

Example – null


{
  "id": "3f425dbd-518b-4fc5-bb8f-77df7ef9ef0c",
  "jsonrpc": "2.0",
  "method": "ce.event",
  "result": {
    "resp": "event",
    "status": "1",
    "riskScore": 687,
    "signalScore": 687,
    "scenarioScore": 0,
    "tokenScore": 0,
    "categoryScore": 0,
    "ofacConfidentScore": 0,
    "debtorProfileId": "9C1C1A87D297C038D71DD1623F03191D",
    "creditorProfile": "2CED9F48EE3B49D97D9263F1AEAB26D8"
  },
  "error": null
}