TAG LINE
TAG LINE
SMALL TITLE

Payment / Pre Authorize

(API Version v7)


Represents a pre-authorization request for a payment gateway.


What can you do with PaymentPreAuthorize?


Properties

Property Details
identity
READ-ONLY
"identity": 17
Type: Number
This is the unique numeric identifier for the PaymentPreAuthorize
paymentMethodId
"paymentMethodId": 26
Type: Number
Unique identifier for the associated PaymentMethod object.
paymentMethodName
"paymentMethodName": "Sample Name"
Type: String
The name of the object associated with the paymentMethodId property.
amount
"amount": 200.5
Type: Number
The amount to pre-authorize for the payment method.
transactionToken
"transactionToken": "123kjsf90832fwf"
Type: String
The token received by the payment gateway for the pre-authorization request.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
createdByUserId
"createdByUserId": 2
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.


End Points

GETPaymentPreAuthorize/
Retrieve all of the PaymentPreAuthorize objects.
Retrieve all of the PaymentPreAuthorize objects.
GET PaymentPreAuthorize/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "paymentMethodId": 7,
            "paymentMethodName": "Sample Text Data",
            "amount": 200.5,
            "transactionToken": "123kjsf90832fwf",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 10,
            "createdByUserName": "Sample Text Data"
        }
    ]
}
GETPaymentPreAuthorize/
Retrieve all of the PaymentPreAuthorize objects.
Retrieve all of the PaymentPreAuthorize objects.
GET PaymentPreAuthorize/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "paymentMethodId": 0,
            "paymentMethodName": "Sample Text Data",
            "amount": 200.5,
            "transactionToken": "123kjsf90832fwf",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 25,
            "createdByUserName": "Sample Text Data"
        }
    ]
}
GETPaymentPreAuthorize/
Retrieve all of the PaymentPreAuthorize objects.
Retrieve all of the PaymentPreAuthorize objects.
GET PaymentPreAuthorize/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "paymentMethodId": 22,
            "paymentMethodName": "Sample Text Data",
            "amount": 200.5,
            "transactionToken": "123kjsf90832fwf",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 0,
            "createdByUserName": "Sample Text Data"
        }
    ]
}
GETPaymentPreAuthorize/
Retrieve all of the PaymentPreAuthorize objects.
Retrieve all of the PaymentPreAuthorize objects.
GET PaymentPreAuthorize/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "paymentMethodId": 20,
            "paymentMethodName": "Sample Text Data",
            "amount": 200.5,
            "transactionToken": "123kjsf90832fwf",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 9,
            "createdByUserName": "Sample Text Data"
        }
    ]
}
GETPaymentPreAuthorize/
Retrieve all of the PaymentPreAuthorize objects.
Retrieve all of the PaymentPreAuthorize objects.
GET PaymentPreAuthorize/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "paymentMethodId": 22,
            "paymentMethodName": "Sample Text Data",
            "amount": 200.5,
            "transactionToken": "123kjsf90832fwf",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 15,
            "createdByUserName": "Sample Text Data"
        }
    ]
}
GETPaymentPreAuthorize/Metadata
Retrieve all of the PaymentPreAuthorize objects.
Retrieve all of the PaymentPreAuthorize objects.
GET PaymentPreAuthorize/Metadata
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "paymentMethodId": 23,
            "paymentMethodName": "Sample Text Data",
            "amount": 200.5,
            "transactionToken": "123kjsf90832fwf",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 16,
            "createdByUserName": "Sample Text Data"
        }
    ]
}
GETPaymentPreAuthorize/Metadata/sql
Retrieve all of the PaymentPreAuthorize objects.
Retrieve all of the PaymentPreAuthorize objects.
GET PaymentPreAuthorize/Metadata/sql
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "paymentMethodId": 9,
            "paymentMethodName": "Sample Text Data",
            "amount": 200.5,
            "transactionToken": "123kjsf90832fwf",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 24,
            "createdByUserName": "Sample Text Data"
        }
    ]
}
GETPaymentPreAuthorize/Paged
Retrieve all of the PaymentPreAuthorize 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 PaymentPreAuthorize objects in a paged fashion.
GET PaymentPreAuthorize/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,
                "paymentMethodId": 26,
                "paymentMethodName": "Sample Text Data",
                "amount": 200.5,
                "transactionToken": "123kjsf90832fwf",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 10,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
GETPaymentPreAuthorize/Paged
Retrieve all of the PaymentPreAuthorize 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 PaymentPreAuthorize objects in a paged fashion.
GET PaymentPreAuthorize/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,
                "paymentMethodId": 9,
                "paymentMethodName": "Sample Text Data",
                "amount": 200.5,
                "transactionToken": "123kjsf90832fwf",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 23,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
GETPaymentPreAuthorize/Paged
Retrieve all of the PaymentPreAuthorize 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 PaymentPreAuthorize objects in a paged fashion.
GET PaymentPreAuthorize/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,
                "paymentMethodId": 10,
                "paymentMethodName": "Sample Text Data",
                "amount": 200.5,
                "transactionToken": "123kjsf90832fwf",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 1,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
GETPaymentPreAuthorize/Paged
Retrieve all of the PaymentPreAuthorize 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 PaymentPreAuthorize objects in a paged fashion.
GET PaymentPreAuthorize/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,
                "paymentMethodId": 13,
                "paymentMethodName": "Sample Text Data",
                "amount": 200.5,
                "transactionToken": "123kjsf90832fwf",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 25,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
GETPaymentPreAuthorize/Paged
Retrieve all of the PaymentPreAuthorize 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 PaymentPreAuthorize objects in a paged fashion.
GET PaymentPreAuthorize/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,
                "paymentMethodId": 25,
                "paymentMethodName": "Sample Text Data",
                "amount": 200.5,
                "transactionToken": "123kjsf90832fwf",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 10,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
GETPaymentPreAuthorize/{id}
Retrieve an instance of the PaymentPreAuthorize object by its ID.
{id}Unique identifier for the PaymentPreAuthorize object.
Retrieve an instance of the PaymentPreAuthorize object by its ID.
GET PaymentPreAuthorize/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "paymentMethodId": 6,
        "paymentMethodName": "Sample Text Data",
        "amount": 200.5,
        "transactionToken": "123kjsf90832fwf",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 15,
        "createdByUserName": "Sample Text Data"
    }
}
GETPaymentPreAuthorize/{id}
Retrieve an instance of the PaymentPreAuthorize object by its ID.
{id}Unique identifier for the PaymentPreAuthorize object.
Retrieve an instance of the PaymentPreAuthorize object by its ID.
GET PaymentPreAuthorize/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "paymentMethodId": 5,
        "paymentMethodName": "Sample Text Data",
        "amount": 200.5,
        "transactionToken": "123kjsf90832fwf",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 9,
        "createdByUserName": "Sample Text Data"
    }
}
GETPaymentPreAuthorize/{id}
Retrieve an instance of the PaymentPreAuthorize object by its ID.
{id}Unique identifier for the PaymentPreAuthorize object.
Retrieve an instance of the PaymentPreAuthorize object by its ID.
GET PaymentPreAuthorize/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "paymentMethodId": 11,
        "paymentMethodName": "Sample Text Data",
        "amount": 200.5,
        "transactionToken": "123kjsf90832fwf",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 11,
        "createdByUserName": "Sample Text Data"
    }
}
GETPaymentPreAuthorize/{id}
Retrieve an instance of the PaymentPreAuthorize object by its ID.
{id}Unique identifier for the PaymentPreAuthorize object.
Retrieve an instance of the PaymentPreAuthorize object by its ID.
GET PaymentPreAuthorize/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "paymentMethodId": 6,
        "paymentMethodName": "Sample Text Data",
        "amount": 200.5,
        "transactionToken": "123kjsf90832fwf",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 22,
        "createdByUserName": "Sample Text Data"
    }
}
GETPaymentPreAuthorize/{id}
Retrieve an instance of the PaymentPreAuthorize object by its ID.
{id}Unique identifier for the PaymentPreAuthorize object.
Retrieve an instance of the PaymentPreAuthorize object by its ID.
GET PaymentPreAuthorize/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "paymentMethodId": 11,
        "paymentMethodName": "Sample Text Data",
        "amount": 200.5,
        "transactionToken": "123kjsf90832fwf",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 4,
        "createdByUserName": "Sample Text Data"
    }
}
POSTPaymentPreAuthorize/
Create a new instance of the PaymentPreAuthorize object. This will send a pre-authorization to the payment gateway for the specified payment method (uses the 'AutoPay' payment method if not specified).
Create a new instance of the PaymentPreAuthorize object.
POST PaymentPreAuthorize/

{
    "paymentMethodId": 15,
    "amount": 200.5,
    "transactionToken": "123kjsf90832fwf",
    "createdByUserId": 21
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "paymentMethodId": 22,
                "paymentMethodName": "Sample Text Data",
                "amount": 200.5,
                "transactionToken": "123kjsf90832fwf",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 25,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
POSTPaymentPreAuthorize/
Create a new instance of the PaymentPreAuthorize object. This will send a pre-authorization to the payment gateway for the specified payment method (uses the 'AutoPay' payment method if not specified).
Create a new instance of the PaymentPreAuthorize object.
POST PaymentPreAuthorize/

{
    "paymentMethodId": 26,
    "amount": 200.5,
    "transactionToken": "123kjsf90832fwf",
    "createdByUserId": 1
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "paymentMethodId": 6,
                "paymentMethodName": "Sample Text Data",
                "amount": 200.5,
                "transactionToken": "123kjsf90832fwf",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 21,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
POSTPaymentPreAuthorize/
Create a new instance of the PaymentPreAuthorize object. This will send a pre-authorization to the payment gateway for the specified payment method (uses the 'AutoPay' payment method if not specified).
Create a new instance of the PaymentPreAuthorize object.
POST PaymentPreAuthorize/

{
    "paymentMethodId": 12,
    "amount": 200.5,
    "transactionToken": "123kjsf90832fwf",
    "createdByUserId": 25
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "paymentMethodId": 19,
                "paymentMethodName": "Sample Text Data",
                "amount": 200.5,
                "transactionToken": "123kjsf90832fwf",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 27,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
POSTPaymentPreAuthorize/
Create a new instance of the PaymentPreAuthorize object. This will send a pre-authorization to the payment gateway for the specified payment method (uses the 'AutoPay' payment method if not specified).
Create a new instance of the PaymentPreAuthorize object.
POST PaymentPreAuthorize/

{
    "paymentMethodId": 10,
    "amount": 200.5,
    "transactionToken": "123kjsf90832fwf",
    "createdByUserId": 16
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "paymentMethodId": 2,
                "paymentMethodName": "Sample Text Data",
                "amount": 200.5,
                "transactionToken": "123kjsf90832fwf",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 18,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
POSTPaymentPreAuthorize/
Create a new instance of the PaymentPreAuthorize object. This will send a pre-authorization to the payment gateway for the specified payment method (uses the 'AutoPay' payment method if not specified).
Create a new instance of the PaymentPreAuthorize object.
POST PaymentPreAuthorize/

{
    "paymentMethodId": 19,
    "amount": 200.5,
    "transactionToken": "123kjsf90832fwf",
    "createdByUserId": 11
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "paymentMethodId": 21,
                "paymentMethodName": "Sample Text Data",
                "amount": 200.5,
                "transactionToken": "123kjsf90832fwf",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 8,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
POSTPaymentPreAuthorize/Capture
Performs a full 'Capture' for the pre-authorization transaction and creates the Payment.
POSTPaymentPreAuthorize/Capture
Performs a full 'Capture' for the pre-authorization transaction and creates the Payment.
POSTPaymentPreAuthorize/Capture
Performs a full 'Capture' for the pre-authorization transaction and creates the Payment.
POSTPaymentPreAuthorize/Capture
Performs a full 'Capture' for the pre-authorization transaction and creates the Payment.
POSTPaymentPreAuthorize/Capture
Performs a full 'Capture' for the pre-authorization transaction and creates the Payment.