Get Payment API

This document provides a comprehensive migration guide for transitioning from RTP to PIPA (PayCenter Instant Payments API) Get Payment API functionality.

It highlights all essential changes including endpoints, response structures, identifiers, and error handling to ensure a smooth migration process.

1. Endpoint & Identifier

API Endpoints

Area	RTP	PIPA
HostName	Sandbox : wag01.eagle.jhapaycenter.com Production: wag01.tango.jhapaycenter.com	Sandbox : ipa01.eagle.jhapaycenter.com Production: ipa01.tango.jhapaycenter.com
URL (Path Parameter)	/v1/institutions/{senderrtn}/environments/{envname}/products/paycenter/networks/rtp/credit-transfers/{Id} Id – Primary identifier returned in CT response.	/v2/paycenter/institutions/{senderrtn}/environments/{envname}/products/pipa/credit-transfers/{PmtHubTrakId} PmtHubTrakId – Primary identifier returned in CT response.
URL (Query Parameter)	/v1/institutions/{senderrtn}/environments/{envname}/products/paycenter/networks/rtp/credit-transfers?OriginatorReferenceId={OriginatorReferenceId} OriginatorReferenceId - Client-provided reference to track the original request.	/v2/paycenter/institutions/{senderrtn}/environments/{envname}/products/pipa/credit-transfers?X-Request-ID={X-Request-ID} X-Request-ID - Client-provided reference to track the original request.

2. Response Body

Area	RTP	PIPA
TransferFee	Not Available	Included

For more details:

• Refer Get Payment by PmtHubTrakId API
• Refer Get Payment by X-Request-ID API

3. Error Response

Area	RTP	PIPA
Structure	Simple object inside CreditTransfer	Standard PIPA error schema (consistent across all APIs)
Key Fields	Message, Error (Code, Description)	ResponseCode, Description, MessageSource, Details[], LogId
Code	Error.Code	Details[].Code
Description	Error.Description	Details[].Description

For more details:

• Refer Get Payment by PmtHubTrakId API
• Refer Get Payment by X-Request-ID API

4. Authentication Error Response

Area	RTP	PIPA
Structure	Returned in XML format	Returned in JSON format

For more details:

• Refer Get Payment by PmtHubTrakId API
• Refer Get Payment by X-Request-ID API

Migration Checklist

Quick Migration Steps

1. Update endpoints → Switch to PIPA hostnames and updated API paths.
2. Update Path parameters → Use PmtHubTrakId instead of Id values for path-based lookups.
3. Update query parameters → Use X-Request-ID instead of OriginatorReferenceId for query-based lookups.
4. Update error handling → Implement the PIPA standard error schema (ResponseCode, Description, MessageSource, Details[], LogId).
5. Update authentication error handling → Expect JSON format instead of XML for authentication errors.