Versions Compared

Old Version 2

changes.mady.by.user Miles Graves

Saved on

compared with

New Version 3

changes.mady.by.user Miles Graves

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A refund or void can be submitted via the API using the /txns endpoint. You can look up additional information about the /txns endpoint in theAPI Reference guide.

Info

About Refund Timeframes

All transactions may be voided before they are batched. If the transaction has already been batched (frequency dependent on Referrer configuration), it will required a refund.

  • Note that there is no technical time limit on when a refund can be issued after a transaction has already been batched. The only limit is the refund policy of individual merchants.

...

Submitting a Refund or Void a Payment via the API

The process of submitting a card payment (sale) refund, an eCheck refund, or voiding an approved transaction is virtually the same. The only difference between these three options is the type value included in the request.

...

All API transaction statuses:

...

Refund a Card Payment via the API

A partial or full refund/void is submitted in the API by sending a POST request to the /txns endpoint and including the Transaction ID of the payment that is being refunded/voided. By default, if no amount is set when submitting a refund/void via the API it will be a full refund for the entire amount of the original transaction (excluding any funds that have been previously partially refunded).

...

type - In the case of a card payment refund this field should be set with the value “5”.

...

Refund an eCheck Payment via the API

For eCheck refunds, the type field should be set to “8”. Additionally, you must submit the customer’s (whom you are sending the eCheck refund to) first name.

...

Code Block
{
    "fortxn": "t1_txn_5f6276c12269b0cc77adb44",
    "type": "5",
    "first": "John"
    "total": "100"
}

...

Void a Payment via the API

To void an approved (but not captured/settled) payment, the type should be set to “4”.

Code Block
{
    "fortxn": "t1_txn_5f1841b4b1200ea4d1af843",
    "type": "4"
}

...

Cancel an approved payment via the API

Info

cancel payment vs. void payment:

  • cancel - Removes the approved payment from the Merchant’s daily batch, but does not reverse the authorization.

  • void - Removes the approved payment from the Merchant’s daily batch AND reverses the authorization.

...