TAG LINE
SMALL TITLE

Retry Rule

(API Version v4)


What can you do with RetryRule?


Properties

Property Details
identity
READ-ONLY
"identity": 17
Type: Number
This is the unique numeric identifier for the RetryRule
ownerId
READ-ONLY
"ownerId": 16
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
paymentRetryRuleId
"paymentRetryRuleId": 6
Type: Number
Unique identifier for the associated PaymentRetryRule object.
paymentRetryRuleName
"paymentRetryRuleName": "Sample Name"
Type: String
The name of the object associated with the paymentRetryRuleId property.
isActive
"isActive": true
Type: Boolean
daysSinceFirstDecline
"daysSinceFirstDecline": 0
Type: Number
paymentActionTypeId
"paymentActionTypeId": 26
Type: Number
Unique identifier for the associated PaymentActionType object.
paymentActionTypeName
"paymentActionTypeName": "Sample Name"
Type: String
The name of the object associated with the paymentActionTypeId property.
paymentActionValue
"paymentActionValue": "Hello World"
Type: String


End Points

DELETEapi/v4/RetryRule/{id}
Delete an instance of the RetryRule object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the RetryRule object.
Delete an instance of the RetryRule object.
DELETE api/v4/RetryRule/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "retryRule"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/RetryRule/
Retrieve all of the RetryRule objects.
Retrieve all of the RetryRule objects.
GET api/v4/RetryRule/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 12,
            "ownerName": "Sample Text Data",
            "paymentRetryRuleId": 7,
            "paymentRetryRuleName": "Sample Text Data",
            "isActive": true,
            "daysSinceFirstDecline": 20,
            "paymentActionTypeId": 3,
            "paymentActionTypeName": "Sample Text Data",
            "paymentActionValue": "Sample Text Data"
        }
    ]
}
GETapi/v4/RetryRule/Paged
Retrieve all of the RetryRule objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the RetryRule objects in a paged fashion.
GET api/v4/RetryRule/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 9,
                "ownerName": "Sample Text Data",
                "paymentRetryRuleId": 4,
                "paymentRetryRuleName": "Sample Text Data",
                "isActive": true,
                "daysSinceFirstDecline": 24,
                "paymentActionTypeId": 19,
                "paymentActionTypeName": "Sample Text Data",
                "paymentActionValue": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/RetryRule/{id}
Retrieve an instance of the RetryRule object by its ID.
{id}Unique identifier for the RetryRule object.
Retrieve an instance of the RetryRule object by its ID.
GET api/v4/RetryRule/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 23,
        "ownerName": "Sample Text Data",
        "paymentRetryRuleId": 21,
        "paymentRetryRuleName": "Sample Text Data",
        "isActive": true,
        "daysSinceFirstDecline": 26,
        "paymentActionTypeId": 2,
        "paymentActionTypeName": "Sample Text Data",
        "paymentActionValue": "Sample Text Data"
    }
}
POSTapi/v4/RetryRule/
Create a new instance of the RetryRule object.
Create a new instance of the RetryRule object.
POST api/v4/RetryRule/

{
    "paymentRetryRuleId": 16,
    "isActive": true,
    "daysSinceFirstDecline": 10,
    "paymentActionTypeId": 22,
    "paymentActionValue": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 10,
                "ownerName": "Sample Text Data",
                "paymentRetryRuleId": 17,
                "paymentRetryRuleName": "Sample Text Data",
                "isActive": true,
                "daysSinceFirstDecline": 27,
                "paymentActionTypeId": 13,
                "paymentActionTypeName": "Sample Text Data",
                "paymentActionValue": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v4/RetryRule/Search
Retreive a list of RetryRule objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of RetryRule objects based on search criteria.
POST api/v4/RetryRule/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 7,
            "ownerName": "Sample Text Data",
            "paymentRetryRuleId": 7,
            "paymentRetryRuleName": "Sample Text Data",
            "isActive": true,
            "daysSinceFirstDecline": 20,
            "paymentActionTypeId": 25,
            "paymentActionTypeName": "Sample Text Data",
            "paymentActionValue": "Sample Text Data"
        }
    ]
}
PUTapi/v4/RetryRule/{id}
Update an existing instance of the RetryRule object.
Update an existing instance of the RetryRule object.
PUT api/v4/RetryRule/{id}

{
    "identity": 1,
    "paymentRetryRuleId": 20,
    "isActive": true,
    "daysSinceFirstDecline": 3,
    "paymentActionTypeId": 3,
    "paymentActionValue": "Sample Text Data"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 0,
                "ownerName": "Sample Text Data",
                "paymentRetryRuleId": 26,
                "paymentRetryRuleName": "Sample Text Data",
                "isActive": true,
                "daysSinceFirstDecline": 19,
                "paymentActionTypeId": 25,
                "paymentActionTypeName": "Sample Text Data",
                "paymentActionValue": "Sample Text Data"
            }
        ]
    }
}