v1

latestOpenAPI 3.0.0All rights reserved2026-07-2439128156.3 KB
Transaction

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).

delete/v2/clients/{ClientID}/transactions/rtp/{RTPNetworkID}

Path parameters

ClientIDstring required

22-character <glossary:ClientID>. Ask TabaPay Support if you need to specify a <glossary:SubClientID>.

RTPNetworkIDstring required

The original 35-character networkID (i.e. the <glossary:RTP> Instruction ID)

Query parameters

requeststring

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

Must use request or response

responsestring

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

Must use response or request

Request body

amountstring

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.

feestring

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.

reasonCodestring

See valid Reason Codes for ?request and ?response

networkstring

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 (<glossary:RTP>), a credit transfer will be sent to reimburse the original transaction.

reversalIDstring

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.

Response

A response to a request for return of funds was accepted (and if applicable, the reimbursement was accepted).

ECstring

Internal Error Code. This is used to help TabaPay team members trace an error.

statusstring

Status of the <glossary:RTP> Delete.

networkRCstring

3-character Network Response Code of Reversal Request or of Reversal Response

networkIDstring

35-character Network ID of Reversal Request or of Reversal Response

Example response

{
  "status": "COMPLETED",
  "networkRC": "000",
  "reimbursement": {
    "networkRC": "000"
  }
}