Recover async-owned settlement for specified CDR without running CDR reconciliation

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 0 and 255
Query Params
string
enum
required

How a settlement that is not moving on its own should be recovered through the backoffice API. Whatever mode is chosen, money already collected for the session stays collected and nothing is refunded here, the modes differ in whether the settlement keeps the plan it already has, what is asked of the payment provider, and whether the settlement carries on afterwards or is closed for good.

RESCHEDULE: tries the settlement again straight away. It keeps the plan it already has and everything already collected, and picks up where it stopped, so the provider is asked only for what is still owed. The settlement stays open and carries on by itself afterwards.

REFRESH_PLAN: plans the settlement again from the configuration in force today and starts it from the beginning of that new plan. Everything already collected is kept and counts towards what is owed, so the provider is asked only for the remainder. The settlement stays open and carries on by itself afterwards.

RETRY_TRUTH_LOOKUP: asks the payment provider once more what became of a payment it never answered for, and records that answer. No new payment is requested and nothing already collected is touched. If the answer settles the question, the settlement stops waiting for support and carries on by itself, if the provider still cannot say, it goes back to waiting for support.

RESUME: lets a settlement that is waiting for support carry on, once whatever was wrong with its data has been put right. It keeps the plan it already has, everything already collected and the attempts it has already used, so the provider is asked only for what is still owed. The settlement stays open and carries on by itself afterwards. It is refused while a payment is still unanswered.

ABANDON: stops the settlement for good. Nothing further is attempted and nothing more is asked of the provider, what has already been collected stays collected, and whether any money is owed back to the customer is not something this operation handles. It is refused while a payment is still unanswered, so it can only close a settlement whose money is already accounted for.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json