Class ReturnRefundsAPIRequest
Properties
| NAME | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| Resource | /v1/institutions/{rtnnumber}/environments/{envname}/products/paycenter/networks/rtp/refund-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 |
|---|---|---|---|
| ReasonCode | string | Yes | Reason Code Enum values: AC03,AM09,CUST,DS24,DUPL,FRAD,FRTR,TECH,UPAY RequestForRefund.ReasonCode |
| Id | string | Yes | This Id will be the unique EndToEndId which is received in Credit Transfer API response's Id field. RequestForRefund.Id |
| UserName | string | Yes | Define the Name of the User Invoking the API RequestForRefund.UserName |
| Notes | string | Free text. Notes about the request for refund. RequestForRefund.Notes |
Request body - JSON representation
{
"RequestForRefund": {
"ReasonCode": "enum(reasoncode)",
"Id": "string",
"UserName": "string",
"Notes": "string"
}
}
Sample Request 1:
POST /v1/institutions/111025466/environments/sandbox/products/paycenter/networks/rtp/refund-requests HTTP/1.1
Host: wag01.eagle.jhapaycenter.com
Authorization: Bearer Op8dNG95eDBKa1B.........Yzh5M1ZyZnNlNEs5rfuI
Content-Type: application/json
Sample Request Body
{
"RequestForRefund": {
"ReasonCode": "CUST",
"Id": "123456789-RTP-IISQB45490",
"UserName": " RTPUATUser",
"Notes": "This is test transaction"
}
}
Sample Request 2:
POST /v1/institutions/111025466/environments/sandbox/products/paycenter/networks/rtp/refund-requests HTTP/1.1
Host: wag01.eagle.jhapaycenter.com
Authorization: Bearer Op8dNG95eDBKa1B.........Yzh5M1ZyZnNlNEs5rfuI
Content-Type: application/json
Sample Request Body
{
"RequestForRefund": {
"ReasonCode": "FRAD",
"Id": "987456218-RTP-IISQB45490",
"UserName": " RTPUATUser",
"Notes": "This is test transaction"
}
}