API Reference
API Reference

Delete RTP Transaction

If using?request: Requests a return of a previously sent RTP push transaction.
If using ?response: Responds to a request of a previously received Request for Return of Funds (for a previously received RTP transaction).

Path Params
string
required

22-character ClientID. Ask Support if you need to specify a SubClientID.

string
required

The original 35-character networkID (i.e. the RTP Instruction ID)

Query Params
string
length between 0 and 0

Use if you are sending a Request for Return of Funds (regarding the original RTP-Credit Transfer).

Must use request or response

string
length between 0 and 0

Use if you are responding to a Request for Return of Funds (regarding a received RTP-Credit Transfer).

Must use response or request

Body Params
string

Partial Reversal Amount. See how to properly format an amount.

Optional. Use is only allowed if using query string ?response. If omitted, the reversal will be for the original amount.

string

The fee the participant charges for returning the funds. See how to properly format an amount.

Exclusively compatible with query string response. Optional, omit if no fee is incurred.

string

See valid Reason Codes for ?request and ?response

string

The payment-rails used to reimburse the original credit transfer

Acceptable values:

  • R: RTP
  • A: ACH Payment
  • W: FedWire
  • C: CHIPS

Exclusively compatible with query string response. Required if reasonCode is ACTC, otherwise omit. If network is R (RTP), a credit transfer will be sent to reimburse the original transaction.

string

The unique identifier of the transaction used to return the funds. Acceptable values:

  • An ACH Trace Number
  • A FedWire IMAD
  • A CHIPS System Sequence Number (SSN)

Exclusively compatible with query string response. Required if reasonCode is ACTC and network is W, A, or C, omit otherwise.

Responses

Language
Credentials
Bearer
JWT
URL
Response
Choose an example:
application/json