TAG LINE
SMALL TITLE

Payment / Pre Authorize

(API Version v3)


Represents a pre-authorization request for a payment gateway.


What can you do with PaymentPreAuthorize?


Properties

Property Details
identity
READ-ONLY
"identity": 12
Type: Number
This is the unique numeric identifier for the PaymentPreAuthorize
paymentMethodId
"paymentMethodId": 12
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": 20
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.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • paymentMethodId
  • amount
  • transactionToken
  • created
  • createdByUserId

End Points

GETapi/v3/PaymentPreAuthorize/
Retrieve all of the PaymentPreAuthorize objects.
Retrieve all of the PaymentPreAuthorize objects.
GET api/v3/PaymentPreAuthorize/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "paymentMethodId": 18,
            "paymentMethodName": "Sample Text Data",
            "amount": 200.5,
            "transactionToken": "123kjsf90832fwf",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 16,
            "createdByUserName": "Sample Text Data"
        }
    ]
}
GETapi/v3/PaymentPreAuthorize/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 api/v3/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": 22,
                "paymentMethodName": "Sample Text Data",
                "amount": 200.5,
                "transactionToken": "123kjsf90832fwf",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 17,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v3/PaymentPreAuthorize/{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 api/v3/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": 17,
        "createdByUserName": "Sample Text Data"
    }
}
POSTapi/v3/PaymentPreAuthorize/
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 api/v3/PaymentPreAuthorize/

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