Class ResponsePaymentRequestAPIRequest
Properties
| NAME | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| Resource | /{version}/institutions/{rtnnumber}/environments/{envname}/products/paycenter/networks/rtp/response-to-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
|
Fields
| Parameter | TYPE | REQUIRED | Description |
|---|---|---|---|
| Status | string | Yes | Enum values: Accepted, Rejected ResponseToRequestForPayment.Status |
| Id | string | Yes | This Id will be the unique payment info id, which is used to identify the payment request. ResponseToRequestForPayment.Id |
| Amount | number | Define the accepted amount on approving the payment request. This is required only when the status is Accepted ResponseToRequestForPayment.Amount | |
| ReasonCode | string | Define the reason for rejecting the payment request. This is required only when the status is Rejected ResponseToRequestForPayment.ReasonCode | |
| Notes | string | Free text. Any additional information or remarks when sending the payment confirmation. ResponseToRequestForPayment.Notes | |
| UserName | string | Yes | Define the Name of the User Invoking the API ResponseToRequestForPayment.UserName |
Request body : JSON representation
{
"ResponseToRequestForPayment": {
"Status": string,
"Id": string,
"Amount": number,
"ReasonCode": string,
"Notes": string,
"UserName": string
}
}
Sample Request 1:
POST /v1/institutions/111025466/environments/sandbox/products/paycenter/networks/rtp/response-to-payment-requests HTTP/1.1
Host: wag01.eagle.jhapaycenter.com
Authorization: Bearer Op8dNG95eDBKa1B.........Yzh5M1ZyZnNlNEs5rfuI
Content-Type: application/json
Sample Request Body 1
{
"ResponseToRequestForPayment": {
"Status": "Accepted",
"Id": "20211027101010101MTBRHQN00885222784",
"Amount": 87193.07,
"Notes": "Sample Note",
"UserName": "Test User"
}
}
Sample Request 2:
POST /v1/institutions/111025466/environments/sandbox/products/paycenter/networks/rtp/response-to-payment-requests HTTP/1.1
Host: wag01.eagle.jhapaycenter.com
Authorization: Bearer Op8dNG95eDBKa1B.........Yzh5M1ZyZnNlNEs5rfuI
Content-Type: application/json
Sample Request Body 2
{
"ResponseToRequestForPayment": {
"Status": "Rejected",
"Id": "20211027101010101MTBRHQN00885222785",
"ReasonCode": "IPAY",
"Notes": "Sample Note",
"UserName": "Test User"
}
}