OpenInvoice Dunning Pause

Overview

Dunning refers to the collections process. There is a provision for webstores to delay or pause the dunning process. Customer care can call Radial Payments with a PaymentDunningPauseRequest message to request to pause the dunning process.

Dunning Pause Request Flow

The dunning pause process includes the following steps:

  1. Customer care or OMS calls Radial Payments with a PaymentDunningPauseRequest message indicating the number of days to pause the dunning cycle.
  2. Radial Payments sends an email to the OpenInvoice payments processor.
  3. Radial Payments sends a PaymentDunningPauseReply message to customer care or OMS.

  • If there is a timeout in either case, customer care or OMS receives a timeout response and can retry the request later.
  • Note: Dunning pause is effective from the date a successful call is completed. For example, if a customer requested a pause for 10 days on 10th August, but because the system is down, customer care completed the call only by 11th August, the dunning pause will be effective for 10 days from 11th August. Based on the date when the retry call is made, customer care can build logic to reduce the number of days to pause the process.

    URI Summary

    Action URI Template URI Example Non-URI Request Response
    POST /v[M.m]//stores/{STORE}/payments/dunningpause/request/{tenderType}.{format} /v1.0/stores/TMSDE/payments/dunningpause/request/OI.xml XML 200 + XML response

    Request Example

    <?xml version="1.0" encoding="UTF-8"?>
    <PaymentDunningPauseRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
      <PaymentContext>
        <OrderId>223</OrderId>
      </PaymentContext>
      <VATInvoiceNumber>1223</VATInvoiceNumber>
      <PausePeriodInDays>5</PausePeriodInDays>
    </PaymentDunningPauseRequest>

    Request Elements

    Element Required Description Type Restriction
    PaymentContext/OrderId Yes Unique identifier for an order taking application. String Max 20 characters allowed
    VATInvoiceNumber Yes String Max 20 characters allowed
    PausePeriodInDays Yes No of days a dunning process should be valid unsigned short

    Response Example

    <?xml version="1.0" encoding="UTF-8"?>
    <PaymentDunningPauseReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
      <PaymentContext>
        <OrderId>223</OrderId>
      </PaymentContext>
      <ResponseCode>Success</ResponseCode>
    </PaymentDunningPauseReply>

    Response Elements

    Element Required Description Type Restriction
    PaymentContext/OrderId Yes Unique identifier for an order taking application used to prevent PaymentSessionId collisions. String Max 20 characters allowed
    ResponseCode Yes Response code String Values: Success