TSP Payment

This API allows a TSP to upload a batch file and send it to the BillPay Connector.
The batch transaction initially appears in the "Customer Batch File List" in a pending state.
The connector automatically processes the file, and the TSP must log in to the ledger customer portal to approve it.
Once approved, the transactions in the batch will be listed under the transaction list in the connector.

Endpoint

Method: POST
URL: {{URL}}/gw/billpay/BillerTransactionService/Payment

Headers

Key	Type	Required	Description
Content-Type	string	Yes	application/json
Signature	string	Yes	{{Signature}}
Authorization	string	Yes	{{Credential}}

---

Request

{
    "api": {
        "apiKey": "16c883cbf4a44bd0acd6b4d3ac80a602",
        "reference": "BusRef202412170021"
    },
    "tspCustomerId": "100000000000001",
    "transactionType": "PAYMENT",
    "transactionDateTime": "20241217123000",
    "product": "RPPS",
    "program": "BILL_PAY",
    "source": "TSP",
    "batchDetails": {
        "totalAmount": "10",
        "batchNumber": "202412171"
    },
    "transactions": [
        {
            "transactionNumber": "T202412171",
            "date": "20241217",
            "time": "1230",
            "type": "PAYMENT",
            "customer": {
                "customerType": "BUSINESS",
                "customerAccountNumber": "02087678987",
                "clientNumber": "265157758",
                "clientNumberType": "SSN",
                "firstName": "Evan",
                "middleName": "H",
                "lastName": "Nickel",
                "address": {
                    "addressLine1": "950 Medical Center Drive",
                    "addressLine2": "",
                    "city": "Sarasota",
                    "state": "FL",
                    "zipCode": "34236"
                },
                "contact": {
                    "phone": "0443637070"
                }
            },
            "channelPartner": {
                "bankSettlementAccountNumber": "200931384666635",
                "bankChannelPartnerName": "NetXD Demo",
                "bankChannelPartnerId": "100000000000001"
            },
            "msb": {
                "name": "Globex Corporation",
                "identifier": "L46177992"
            },
            "destination": {
                "paymentProcessor": {
                    "name": "RPPS"
                },
                "biller": {
                    "billerName": "Ashley Stewart",
                    "billerIdNumber": "8730000020",
                    "address": {
                        "addressLine1": "PO Box 659450",
                        "addressLine2": "",
                        "city": "San Antonio",
                        "state": "TX",
                        "zipCode": "78265-9450"
                    }
                }
            },
            "amount": "10",
            "currency": "USD",
            "purpose": "CREDIT CARD"
        }
    ]
}

Response: 200

Request Parameters

Parameter	Description
apiKey Mandatory	String API key for authentication
reference Mandatory	String Unique request identifier
tspCustomerId Mandatory	String Customer ID
transactionType Mandatory	String Transaction type Constant: PAYMENT
transactionDateTime Mandatory	String Unix timestamp
product Mandatory	String Product Constant: RPPS
program Mandatory	String Program Constant: BILL_PAY
source Mandatory	String Source Constant: TSP
batchDetails.totalAmount Mandatory	String Total amount of the batch
batchDetails.batchNumber Mandatory	String Unique batch number
transactionNumber Mandatory	String Unique transaction number
date Mandatory	String Transaction date
time Optional	String Transaction time
type Mandatory	String Transaction type Constant: PAYMENT
customer.customerType Mandatory	String Customer Type
customer.customerAccountNumber Mandatory	String Customer Account Number
customer.clientNumber Optional	String Customer ID
customer.clientNumberType Optional	String Customer type (SSN, TIN)
customer.firstName Mandatory	String First name
customer.middleName Optional	String Middle name
customer.lastName Mandatory	String Last name
customer.address.addressLine1 Optional	String Address Line 1
customer.address.addressLine2 Optional	String Address Line 2
customer.address.city Optional	String City
customer.address.state Optional	String State
customer.address.zipCode Optional	String Zip Code
customer.contact.phone Optional	String Phone number
channelPartner.bankSettlementAccountNumber Mandatory	String Customer Account Number
channelPartner.bankChannelPartnerName Mandatory	String Customer Name
channelPartner.bankChannelPartnerId Mandatory	String Customer ID
msb.name Optional	String MSB Name
msb.identifier Optional	String MSB Identifier
destination.paymentProcessor.name Mandatory	String Payment Processor Constant: RPPS
destination.biller.billerName Mandatory	String Biller Name
destination.biller.billerIdNumber Mandatory	String Biller ID
destination.biller.address.addressLine1 Optional	String Biller Address Line 1
destination.biller.address.addressLine2 Optional	String Biller Address Line 2
destination.biller.address.city Optional	String Biller City
destination.biller.address.state Optional	String Biller State
destination.biller.zipCode Optional	String Biller Zip Code
amount Mandatory	String Transaction amount
currency Mandatory	String Currency Example: USD
purpose Mandatory	String Transaction reason

{
    "api": {
        "apiKey": "16c883cbf4a44bd0acd6b4d3ac80a602",
        "reference": "BusRef202412170021"
    },
    "tspCustomerId": "100000000000001",
    "status": "000",
    "validRecords": [
        {
            "Records": {
                "T202412171": "PENDING_VERIFICATION"
            }
        }
    ]
}