Create Manual Retry

POST 
/subscriptions/:subscriptionId/billing-cycles/:billingCycleId/manual-retries

Creates a manual retry for a specific billing cycle. This enables Merchants to retry a specific billing cycle through an API call. Billing cycles for which a manual retry is authorized are the ones with a final status of Error or Failed and no more Automatic retries would be processed for them.

info

The request must provide the following header: x-api-key: {merchantKey}

Request

Path Parameters

subscriptionId stringrequired
Unique Identifier of the created Subscription. Format: Subscription + - + <UUID>
Example: Subscription-4903f0f3-d718-404b-a675-167eacfabe12
billingCycleId stringrequired
Unique Identifier of the created Billing Cycle. Format: BillingCycle + - + <UUID>
Example: BillingCycle-44401c1b-c762-42dd-81bc-fd1fbad54af2

Header Parameters

Content-Type stringrequired

Must be application/json

Accept-Language stringrequired

Must be be en-US

Origin stringrequired

The origin of the request

User-Agent stringrequired

The client making the request

x-api-key stringrequired

x-api-key: {merchantKey}

application/json

Body

Bodyrequired

reasonstring

Reason for the manual reprocessing

Possible values: <= 128 characters

Example

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

Responses

201

Manual retry created successfully

application/json

Schema

Schema

idstringrequired
Unique Identifier of the Manual Retry. Format: Retry + - + <UUID>
Example: ManualTransaction-c58fed85-7afb-4184-a283-f88060de6e
createdAtstring<date-time>required
Timestamp of when the manual retry was created.
Example: 2021-05-10T15:38:01.02Z
updatedAtstring<date-time>required
Timestamp of when the manual retry was last updated.
Example: 2021-05-10T15:38:01.02Z
transactionIdstringrequired
Unique Identifier of the Transaction. Format: Transaction + - + <UUID>
Example: transaction-6a05ccb8-9c58-4907-9014-8cedd51d0464
reasonstringrequired
Reason for the transaction reprocessing.
Possible values: <= 128 characters
Example: Reprocessing a failed transaction
extraInfostringnullable
Reason for the transaction reprocessing.
Possible values: <= 128 characters
Example: Reprocessing a failed transaction
customReferencesobjectnullable

Custom references associated with the subscription.

criteria object[]nullable
An array of key-value pair objects. Please refer to Data Model for details.
Array [
namestring
valuestring
]
targetMerchantAccountReferencestringnullable

Target merchant account reference if applicable.

Possible values: <= 100 characters

Example (auto)

{
  "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"
}

Example

{
  "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"
}

400

Bad Request

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceIdstring

Internally generated trace_id for this error message so it can be found easily in the logs.

errors object[]
Array [
messagestring
A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.
codestring
A pre-defined code from the list of error codes.
propertystring
The property from the request object which the error is linked to.
context object
A json object containing a list of predefined properties which are filled based on the error.
typestring
minimumnumber
maximumnumber
maxLengthinteger
allowedValuesstring[]
]

Example (auto)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Value out of bounds. Value must be between 1 and 100",
      "code": "value_out_of_bounds",
      "property": "someField",
      "context": {
        "minimum": 1,
        "maximum": 100
      }
    }
  ]
}

401

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceIdstring

Internally generated trace_id for this error message so it can be found easily in the logs.

errors object[]
Array [
messagestring
A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.
codestring
A pre-defined code from the list of error codes.
propertystring
The property from the request object which the error is linked to.
context object
A json object containing a list of predefined properties which are filled based on the error.
typestring
minimumnumber
maximumnumber
maxLengthinteger
allowedValuesstring[]
]

Example (auto)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You are not authenticated to perform this request.",
      "code": "unauthorized"
    }
  ]
}

403

Forbidden

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceIdstring

Internally generated trace_id for this error message so it can be found easily in the logs.

errors object[]
Array [
messagestring
A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.
codestring
A pre-defined code from the list of error codes.
propertystring
The property from the request object which the error is linked to.
context object
A json object containing a list of predefined properties which are filled based on the error.
typestring
minimumnumber
maximumnumber
maxLengthinteger
allowedValuesstring[]
]

Example (auto)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You do not have permissions to perform this request.",
      "code": "forbidden"
    }
  ]
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceIdstring

Internally generated trace_id for this error message so it can be found easily in the logs.

errors object[]
Array [
messagestring
A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.
codestring
A pre-defined code from the list of error codes.
propertystring
The property from the request object which the error is linked to.
context object
A json object containing a list of predefined properties which are filled based on the error.
typestring
minimumnumber
maximumnumber
maxLengthinteger
allowedValuesstring[]
]

Example (auto)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

traceIdstring

Internally generated trace_id for this error message so it can be found easily in the logs.

errors object[]
Array [
messagestring
A predefined string which describes the error. The purpose of the message is to allow for future usage of translation.
codestring
A pre-defined code from the list of error codes.
propertystring
The property from the request object which the error is linked to.
context object
A json object containing a list of predefined properties which are filled based on the error.
typestring
minimumnumber
maximumnumber
maxLengthinteger
allowedValuesstring[]
]

Example (auto)

{
  "traceId": "string",
  "errors": [
    {
      "message": "string",
      "code": "string",
      "property": "string",
      "context": {
        "type": "string",
        "minimum": 0,
        "maximum": 0,
        "maxLength": 0,
        "allowedValues": [
          "string"
        ]
      }
    }
  ]
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}