Versions Compared

Key

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

...

Info

If you are utilising the Payrix HPP or Payrix eDDR, the Payrix page automatically takes care of the first 2 steps. Once the customer has completed the Payrix HPP or Payrix eDDR, you can schedule a debit via API.

...

Q: How to determine the result of the transaction for a

...

Card Debit

Scheduled Card Debit - (2 Business day setttlement)

...

  • Following the above API, use our POST Acknowledge transaction status change to acknowledge the transactions and remove them from the data set when you next call the Get New Status Search above.

  • If the transaction status changes again after you have removed it from the data set, it will be returned in the GET Search for transaction status changes to notify you of the change in status.

    • e.g. Search for specific types of transactions (single or list)

       

    • PDB = Payer Debit Bank

    • PDC = Payer Debit Card

...

Q: How to cancel a scheduled debit from processing?

It is recommended to utilise any of the 'Find Schedule Details ' API in conjunction with the DELETE Delete Single Payment to confirm the scheduled debit was cancelled successfully.

For example:

  1. Call GET Look up a scheduled payment or GET Find a Payers scheduled payments or GET Search all scheduled payments to identify the 'scheduledpaymentid'.

    • If the 'scheduledpaymentid' that you are planning to cancel is returned in this API call, the debit has not yet been picked up for processing and you are still able to cancel the scheduled debit.

    • If the 'scheduledpaymentid' is not returned, the debit has been processed and can no longer be cancelled.

  2. Cancel the scheduled debit by calling Delete Single Payment

    • This will return a 200 response

  3. Confirm the cancellation by calling either of the 3 GET API calls.

    • If the 'scheduledpaymentid' is not returned, the scheduled debit has been deleted.

Info

In order to cancel a scheduled debit from processing, it must be cancelled before Payrix has picked it up for processing. If the scheduled debit has already been processed, you can no longer cancel or stop the debit from processing.

...