Create Manual retry

Request parameters

Field	Description	Type	Length	Mandatory
reason	Reason of the manual reprocessing	String	128	Yes

info

The request must provide the following header:

x-api-key: {merchantKey}

Request sample

Path:

POST {baseURL}/subscriptions/Subscription-4903f0f3-d718-404b-a675-167eacfabe12/billing-cycles/BillingCycle-44401c1b-c762-42dd-81bc-fd1fbad54af2/manual-retries

Header:

Content-Type: application/json
Accept-Language: en-US

{
    "reason": "Reprocessing a failed transaction"
}

Response parameters

Field	Description	Type	Length	Mandatory
id	Manual retry ID, automatically generated by the system Format: "PaymentSeries" + "-" + <UUID> Example: "retry-6a05ccb8-9c58-4907-9014-8cedd51d0464"	String	42	Yes
createdAt	Timestamp of when the manual retry was created. Format: yyyy-MM-dd'T'HH:mm:ss.SS'Z (E.g: 2021-02-11T15:00:44.718Z)	String	24	Yes
transactionId	Id of the transaction created according to this manual retry. Automatically generated by the system Format: "Transaction" + "-" + <UUID> Example: "Transaction-5f391daa-80a8-4292-96d9-3fdc1a12192b"	String	48	Yes
reason	Reason of the transaction reprocessing	String	125	Yes

Response sample

Status Code:

201 (Created)

Header:

Content-Type: application/json
Accept-Language: en-US

{
    "id": "retry-6a05ccb8-9c58-4907-9014-8cedd51d0464",
    "createdAt": "2021-05-10T15:38:01.02Z",
    "updatedAt": "2021-05-10T15:38:01.02Z",
    "transactionId": "transaction-6a05ccb8-9c58-4907-9014-8cedd51d0464",
    "reason": "Reprocessing a failed transaction"
}

info

For error handling, please refer to this section.