Delete RTP Transaction

Request for Return of Funds (for a previously sent RTP Transaction).

Response to Request for Return of Funds (for a previously received Request for Return of Funds)

Query Strings:

  • ?reversal (required to initiate a Request for Return of Funds)
  • ?response (required to respond to a Request for Return of Funds)

If you are an ISO (Independent Sales Organization), you will need to specify a SubClientID (see notes below).


URL:

https://<FQDN>/v2/clients/<ClientIDISO>/transactions/rtp/<RTPNetworkID>?request
https://<FQDN>/v2/clients/<ClientIDISO>/transactions/rtp/<RTPNetworkID>?response

  • If using ?request, the RTPNetworkID is the Instruction Identification of the original pacs.008 sent. This is also equivalent to the networkID field in the response of Create Transaction.
  • If using ?response, the RTPNetworkID is the Instruction Identification of the original pacs.008 received (i.e. The camt.056 you are responding to, is requesting to reverse the pacs.008 with the Instruction Identification equal to RTPNetworkID)

Request:

JSON Name Value Required Default Description Choice
reasonCode String
4 characters
R See the available reason codes for request.
See the available reason codes for response.
amount String
Amount
O The Amount the FI is returning. Use is allowed only if using ?response, and reasonCode is ACTC. If omitted, the original received amount is the assumed returned amount.
fee String
Amount
O Fee sending FI charges, if any. Use is allowed only if using ?response
network String
1-character
C The payment rails used to reimburse the original credit transfer. Use is allowed only if using ?response, and reasonCode is ACTC (omit otherwise).
Acceptable Values:
  • R: RTP
  • A: ACH Payment
  • W: FedWire
  • C: CHIPS
reversalID String C The identification of the reimbursement transaction, the receiving FI can use to trace. Use is required only if using ?response, reasonCode is ACTC, and network is W, A, or C (omit otherwise).
Acceptable Values Include:
  • An ACH Trace Number
  • A FedWire IMAD
  • A CHIPS FedWire

Sample Request:

Pack your Request, the following Samples shown here are unpacked only for human readability:

Request for Return of Funds:

https://<FQDN>/v2/clients/<ClientIDISO>/transactions/rtp/20220809000000000T1BABC00000000001?request

{
  "reasonCode": "CUST"
}

-----

Response to Request for Return of Funds (RTP Network):

https://<FQDN>/v2/clients/<ClientIDISO>/transactions/rtp/20220809000000000T1BABC00000000002?response

{
  "reasonCode": "ACTC",
  "network": "R"
}

-----

Response to Request for Return of Funds (non RTP Network):

https://<FQDN>/v2/clients/<ClientIDISO>/transactions/rtp/20220809000000000T1BABC00000000002?response

{
  "reasonCode": "ACTC",
  "network": "A",
  "reversalID": "12345678910"
}



Response:

Status Codes:

Status Code Description
200 OK A Response to Request for Return of Funds was successfully sent and accepted. And, if applicable, the reimbursement was accepted (only applicable if credit transfer was sent as the reimbursement payment).
202 Accepted A Request for Return of Funds was successfully sent and received.
207 Multi-Status One or more Failures occurred while processing the Request.

See Status Codes for other possible Status Codes that might be returned.


Response Data:

JSON Name Value Description Status Code
200 207 Other
SC Integer
3-digit code
HTTP Status Code O
EC String
1 or 8 characters
Internal Error Code O
EM String Error Message O O
status String Status
reimbursement object Reimbursement
Included if electing to send a credit transfer to reimburse.
C O
networkRC String
3-character code
Reversal Response
Network Response Code
O
networkID String
35-character ID
Instruction ID of Credit Transfer Reimbursement
Network Response Code
O

Sample Responses:

Request for Return of Funds Successfully Sent:
{
  "SC": 202,
  "EC": "0",
  "status": "ACCEPTED",
  "networkRC": "000",
  "networkID": "M20220809000000000T1BABC0000000002"
}

-----

Response to Request for Return of Funds and Reimbursement 
Successfully Sent and Accepted (RTP Network):
{
  "SC": 200,
  "EC": "0",
  "status": "COMPLETED",
  "networkRC": "000",
  "networkID": "M20220809000000000T1BABC0000000003"
  "reimbursement": 
  {
      "networkRC": "000",
      "networkID": "20220809000000000T1BABC00000000004"
  }
}

-----

Response to Request for Return of Funds Successfully Sent (non-RTP Network)
{
  "SC": 200,
  "EC": "0",
  "status": "COMPLETED",
  "networkRC": "000",
  "networkID": "M20220809000000000T1BABC0000000003"
}

Notes:

For Clients who are an ISO (Independent Sales Organization), to specify your ClientID and a SubClientID, use the underscore character ("_") to separate the two values: <ClientID>_<SubClientID> where:

  • ClientID is your unique 22-character string and
  • SubClientID is an assigned 4, 6 or 8-digit value.

There are two use cases: a request for return of funds and a response to request for return of funds.

  1. Request for Return of Funds:
    A status of ACCEPTED and networkRC equals to 000 means a request for a return of funds was successful.
  2. Response to Request for Return of Funds:
    A status of COMPLETED and networkRC equals to 000 (and if applicable, reimbursement.networkRC equals to 000) means a response to request for a return of funds was successfully sent and received (and if applicable, a reimbursement was sent and accepted).

We will only keep transactions accessible to the TabaPay API for approximately 120 days. This means that Delete Transaction will only work for transactions within approximately 120 days. However, we archive transactions for many years (as legally required).