Class RequestPaymentAPIResponse

---

Successful Response

If successful, the response body contains a newly created instance of RequestForPayment

Name	TYPE	REQUIRED	Description
Id	string	Yes	Unique EndToEndId (which is set in the Pain013 request message) reference for the transaction. RequestForPayment.Id
Status	string	Yes	Status of the Transaction. Enum values: Pending Pending - Successfully submit the RTP transaction to RTP Network. It’s an Ack. Rule: Intimation of successful posting the transaction to Recipient via EES events. RequestForPayment.Status
Other fields in the Response	string		The remaining fields are replica of request (RequestForPayment) which is received. Refer the field's description in "Request body" section above.

Failure Response

If failure, the response body contains a newly created instance of

Name	TYPE	REQUIRED	Description
Message	string	Yes	Free text. RequestForPayment.Message
Code	string	Yes	Error code RequestForPayment.Code
Description	string	Yes	Error description RequestForPayment.Description

Successful Response : JSON representation

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

Failure Response : JSON representation

{
	"RequestForPayment": {
		"Message": string,
		"Error": {
			"Code": string,
			"Description": string
		}
	}
}

Sample Response : Success Scenario

{
  "RequestForPayment": {
    "Id": "123456798-RTP-PWPCY14452",
    "Status": "Pending",
    "Creditor": {
      "AccountNumber": "123456789",
      "UltimateCreditor": {
        "Name": "Martin Hess"
      }
    },
    "Debtor": {
      "Name": "Reck Deborah",
      "RoutingNumber": "234567891",
      "AccountNumber": "11122233344455"
    },
    "PaymentDescription": {
      "Amount": 100.5,
      "OriginatorType": "BUSINESS",
      "UserName": "RTPUATUser",
      "IsAmountModifyAllowed": true,
      "PaymentDueDate": "2021-01-31",
      "Notes": "Testing Transaction"
    }
  }
}

Sample Response : Error Scenario

{
  "RequestForPayment": {
    "Message": "Validation failed",
    "Error": {
      "Code": "70019",
      "Description": "Requested Execution Date is invalid"
    }
  }
}