Overview
Purpose
This document provides detailed reference information for the JH PayCenter Instant Payment platform, helping users understand its APIs and their usage. PayCenter offers resources for Credit Transfer, Request for Payment, and related functionalities to access the Instant Payments network.
Who Can Use It
Financial institutions or partners can connect directly to the JH PayCenter Instant Payment API to initiate fund transfers and request payments for their customers.
Environments
JH PayCenter provides two environments: Sandbox and Production.
-
Sandbox
- A production-like testing environment where you can safely integrate, test, and validate your application or solution before going live.
-
Production
- The live environment where your application or solution is launched. This environment supports real-time transactions and actual fund movement.
Authentication Model
To access the JH PayCenter Instant Payment API, OAuth 2.0 is used as the authentication mechanism. Please refer to the Authentication Framework section for detailed instructions on obtaining and using the required credentials.
Project Keys
The following table summarizes the keys and describes how they are used.
| Environment | Keys | Description |
|---|---|---|
| Sandbox | - Consumer Key - Consumer Secret | Private keys used for API authentication in the Sandbox environment |
| Production | - Consumer Key - Consumer Secret | Private keys used for API authentication in the Production environment |
JH PayCenter will provide the client credentials (consumer key and consumer secret) during onboarding.
Service Endpoint
The following endpoints are used to access JH PayCenter Instant Payments APIs.
| Environment | Base URL |
|---|---|
| Sandbox | https://ipa01.eagle.jhapaycenter.com |
| Production | https://ipa01.tango.jhapaycenter.com |
API
The following are the API methods supported by the service.
| Methods | API | URL | Description |
|---|---|---|---|
| POST | Token Generator | /token | Request OAuth 2.0 access token (JWT) generator |
| GET | Check Eligibility | /v2/paycenter/institutions/environments/{envname}/products/pipa/financial-institutions | Check if RTN is available on respective rails |
| POST | Payment | /v2/paycenter/institutions/{senderrtn}/environments/{envname}/products/pipa/credit-transfers | Initiate an outbound payment |
| GET | Payment | /v2/paycenter/institutions/{senderrtn}/environments/{envname}/products/pipa/credit-transfers/{pmthubtrakid} | Retrieve the payment details |
| GET | Payment | /v2/paycenter/institutions/{senderrtn}/environments/{envname}/products/pipa/credit-transfers | Retrieve the payment details |
| POST | Payment Request | /v2/paycenter/institutions/{senderrtn}/environments/{envname}/products/pipa/payment-requests | Initiate an outbound payment request |
| PATCH | Payment Request | /v2/paycenter/institutions/{senderrtn}/environments/{envname}/products/pipa/payment-requests/{pmthubtrakid}/response | Respond to payment request |
| GET | Payment Request | /v2/paycenter/institutions/{senderrtn}/environments/{envname}/products/pipa/payment-requests/{pmthubtrakid} | Retrieve the payment request details |
| GET | Payment Request | /v2/paycenter/institutions/{senderrtn}/environments/{envname}/products/pipa/payment-requests | Retrieve the payment request details |
Integration with JH Enterprise Event System (EES)
The JH PayCenter Instant Payments system publishes 800 distinct events to the JH Enterprise Event System (EES). Financial Institutions or Partners must subscribe to these events to receive real-time updates and ensure smooth tracking and visibility of all transaction activities.
For detailed documentation on JH Enterprise Event System (EES), visit: Jack Henry – Enterprise Event System (EES)