Class RequestPaymentAPIRequest

---

Properties

NAME	TYPE	REQUIRED	DESCRIPTION
Resource	/v1/institutions/{rtnnumber}/environments/{envname}/products/paycenter/networks/rtp/payment-requests
Request Method	HTTP POST
Response format	JSON
Content Type	application/json	Yes	Specify this as a "Content-Type" header property
Authorization	Bearer access_token	Yes	Specify this as a "Authorization" header property and pass OAuth 2.0 access token

Path parameters

Parameter	TYPE	REQUIRED	Description
rtnnumber	string	Yes	Debtor Financial Institution Routing Number
envname	String	Yes	Denotes environment name where the API referred Possible values SANDBOX PROD

Fields (Creditor section)

Name	TYPE	REQUIRED	Description
AccountNumber	string	Yes	Creditor routing number. RequestForPayment.Creditor.AccountNumber
Name	string		Ultimate Creditor name. RequestForPayment.Creditor.UltimateCreditor.Name

Fields (Debtor section)

Name	TYPE	REQUIRED	Description
Name	string	Yes	Debtor name. RequestForPayment.Debtor.Name
RoutingNumber	string	Yes	Creditor Routing number. RequestForPayment.Creditor.RoutingNumber
AccountNumber	string	Yes	Creditor account number. RequestForPayment.Creditor.AccountNumber

Fields (Payment Description section)

Name	TYPE	REQUIRED	Description
Amount	Number (double- precision format)	Yes	Amount to be transferred. RequestForPayment.PaymentDescription.Amount
OriginatorType	string	Yes	Define Originator type. Enum values: BUSINESS, CONSUMER Rule: For CONSUMER, none of the ultimate fields should be supplied For BUSINESS, ultimate creditor fields can be supplied RequestForPayment.PaymentDescription.OriginatorType
UserName	string	Yes	Define the Name of the User Invoking the API RequestForPayment.PaymentDescription.UserName
Notes	string		Free text. RequestForPayment.PaymentDescription.Notes
IsAmountModifyAllowed	boolean		RequestForPayment.PaymentDescription.IsAmountModifyAllowed
PaymentDueDate	string (format: YYYY-MM-DD)	Yes	Payment due date RequestForPayment.PaymentDescription.PaymentDueDate

Request body : JSON representation

{
	"RequestForPayment": {
		"Creditor": {
			"AccountNumber": string,
			"UltimateCreditor": {
				"Name": string
			}
		},
		"Debtor": {
			"Name": string,
			"RoutingNumber":string,
			"AccountNumber": string
		},
		"PaymentDescription": {
			"Amount": number,
			"OriginatorType": enum (type),
			"UserName": string,
			"IsAmountModifyAllowed": boolean,
			"PaymentDueDate": string,
			"Notes": string
		}
	}
}

Sample Request 1: OriginatorType - BUSINESS

POST /v1/institutions/111025466/environments/sandbox/products/paycenter/networks/rtp/payment-requests HTTP/1.1
Host: wag01.eagle.jhapaycenter.com
Authorization: Bearer GYJ8NG95eDBKa1B.........Yzh5M1ZyZnNlNUVjyjuI
Content-Type: application/json

Sample Request Body

{
	"RequestForPayment": {
		"Creditor": {
			"AccountNumber": "123456789",
			"UltimateCreditor": {
				"Name": "Martin Hess"
			}
		},
		"Debtor": {
			"Name": "Reck Deborah",
			"RoutingNumber": "234567891",
			"AccountNumber": "11122233344455"
	},
	"PaymentDescription": {
		"Amount": 100.50,
		"OriginatorType": "BUSINESS",
		"UserName": "RTPUATUser",
		"IsAmountModifyAllowed": true,
		"PaymentDueDate": "2021-01-31",
		"Notes": "This is test transaction"
	}
}

Sample Request 2: OriginatorType - CONSUMER

POST /111025466/environments/sandbox/products/paycenter/networks/rtp/payment-requests HTTP/1.1
Host: wag01.eagle.jhapaycenter.com
Authorization: Bearer GYJ8NG95eDBKa1B.........Yzh5M1ZyZnNlNUVjyjuI
Content-Type: application/json

Sample Request Body

{
	"RequestForPayment": {
		"Creditor": {
			"AccountNumber": "123456789"
		},
		"Debtor": {
			"Name": "Reck Deborah",
			"RoutingNumber": "234567891",
			"AccountNumber": "11122233344455"
	},
	"PaymentDescription": {
		"Amount": 100.50,
		"OriginatorType": "CONSUMER",
		"UserName": "RTPUATUser",
		"IsAmountModifyAllowed": true,
		"PaymentDueDate": "2021-01-31",
		"Notes": "This is test transaction"
	}
}