TAG LINE
SMALL TITLE

Payment / Retry Rule

(API Version v4)


Represents an internal retry mechanism for payment collection.


What can you do with PaymentRetryRule?


Properties

Property Details
identity
READ-ONLY
"identity": 23
Type: Number
This is the unique numeric identifier for the PaymentRetryRule
ownerId
READ-ONLY
"ownerId": 1
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.
name
"name": "Secondary Try"
Type: String
The user defined name for the Retry Rule.
isActive
"isActive": true
Type: Boolean
Whether or not this retry rule is aviailble to be used.
minimumOverdue
"minimumOverdue": 14
Type: Number

DataFlow PATCH objects:


End Points

DELETEapi/v4/Payment/RetryRule/{id}
Delete an instance of the PaymentRetryRule 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 PaymentRetryRule object.
Delete an instance of the PaymentRetryRule object.
DELETE api/v4/Payment/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": "paymentRetryRule"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Payment/RetryRule/
Retrieve all of the PaymentRetryRule objects.
Retrieve all of the PaymentRetryRule objects.
GET api/v4/Payment/RetryRule/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 14,
            "ownerName": "Sample Text Data",
            "name": "Secondary Try",
            "isActive": true,
            "minimumOverdue": 0
        }
    ]
}
GETapi/v4/Payment/RetryRule/Paged
Retrieve all of the PaymentRetryRule 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 PaymentRetryRule objects in a paged fashion.
GET api/v4/Payment/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": 19,
                "ownerName": "Sample Text Data",
                "name": "Secondary Try",
                "isActive": true,
                "minimumOverdue": 16
            }
        ]
    }
}
GETapi/v4/Payment/RetryRule/Paged/Detail
Retrieve all of the PaymentRetryRule objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the PaymentRetryRule objects in a paged fashion with all object details.
GET api/v4/Payment/RetryRule/Paged/Detail
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": 0,
                "ownerName": "Sample Text Data",
                "name": "Secondary Try",
                "isActive": true,
                "minimumOverdue": 19,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v4/Payment/RetryRule/{id}
Retrieve an instance of the PaymentRetryRule object by its ID.
{id}Unique identifier for the PaymentRetryRule object.
Retrieve an instance of the PaymentRetryRule object by its ID.
GET api/v4/Payment/RetryRule/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 5,
        "ownerName": "Sample Text Data",
        "name": "Secondary Try",
        "isActive": true,
        "minimumOverdue": 10
    }
}
GETapi/v4/Payment/RetryRule/{id}/Detail
Retrieve deep detail of the PaymentRetryRule object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the PaymentRetryRule object.
Retrieve deep detail of the PaymentRetryRule object by its ID.
GET api/v4/Payment/RetryRule/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 7,
        "ownerName": "Sample Text Data",
        "name": "Secondary Try",
        "isActive": true,
        "minimumOverdue": 7,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v4/Payment/RetryRule/{id}
Update or Add the PaymentRetryRule object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the PaymentRetryRule object.
Update or Add the PaymentRetryRule object and optionally make changes to any child objects.
PATCH api/v4/Payment/RetryRule/{id}

{
    "details": {},
    "paymentRetryRules": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "Secondary Try",
                "isActive": true,
                "minimumOverdue": 19
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "paymentRetryRule",
                "instance": {
                    "identity": 1,
                    "ownerId": 27,
                    "ownerName": "Sample Text Data",
                    "name": "Secondary Try",
                    "isActive": true,
                    "minimumOverdue": 5
                }
            }
        ]
    }
}
POSTapi/v4/Payment/RetryRule/
Create a new instance of the PaymentRetryRule object.
Create a new instance of the PaymentRetryRule object.
POST api/v4/Payment/RetryRule/

{
    "name": "Secondary Try",
    "isActive": true,
    "minimumOverdue": 10
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 26,
                "ownerName": "Sample Text Data",
                "name": "Secondary Try",
                "isActive": true,
                "minimumOverdue": 2
            }
        ]
    }
}
POSTapi/v4/Payment/RetryRule/Search
Retreive a list of PaymentRetryRule 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 PaymentRetryRule objects based on search criteria.
POST api/v4/Payment/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": 23,
            "ownerName": "Sample Text Data",
            "name": "Secondary Try",
            "isActive": true,
            "minimumOverdue": 16
        }
    ]
}
PUTapi/v4/Payment/RetryRule/{id}
Update an existing instance of the PaymentRetryRule object.
Update an existing instance of the PaymentRetryRule object.
PUT api/v4/Payment/RetryRule/{id}

{
    "identity": 1,
    "name": "Secondary Try",
    "isActive": true,
    "minimumOverdue": 5
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 12,
                "ownerName": "Sample Text Data",
                "name": "Secondary Try",
                "isActive": true,
                "minimumOverdue": 20
            }
        ]
    }
}