Skip to main content

RequestPaymentAPI

The Request for Payment message is sent by the Creditor (sending party) to the Debtor (receiving party). This message is used to request the initiation of a Credit Transfer message (a credit payment) from the receiving party.

Success Scenario:

  • Post API request with the headers, body and authorization.
  • Request data is validated in the business layer.
  • Creditor account inquiry will happen to check valid creditor account.
  • If valid, Request for payment transaction message is sent to RTP Network.
  • API response with transaction id is immediately sent with status as "Pending". This is a acknowledge of "successful posting to RTP Network"
  • RTP Network send back to status report (pacs002) with success status ACTC
  • User will be notified using EES event 800

Failure Scenario 1:

  • Post API request with the headers, body and authorization.
  • Request data is validated in the business layer.
  • Creditor account inquiry will happen to check valid creditor account.
  • If valid, Request for payment transaction message is sent to RTP Network.
  • API response with transaction id is immediately sent with status as "Pending". This is a acknowledge of "successful posting to RTP Network".
  • RTP Network send back to status report (pacs002) with success status RJCT.
  • User will be notified using EES event 800.

Failure Scenario 2:

  • Post API request with the headers, body and authorization.
  • Request data is validated in the business layer.
  • If the data validation fails then API response with error payload which contains error code & description.

Parameters

TYPENAMEDESCRIPTION
RequestPaymentAPIRequestrequest

Returns

TYPEDESCRIPTION
RequestPaymentAPIResponse