TAG LINE
TAG LINE
SMALL TITLE
Represents a pre-authorization request for a payment gateway.
identity READ-ONLY | "identity": 0 Type: Number This is the unique numeric identifier for the PaymentPreAuthorize |
paymentMethodId | "paymentMethodId": 4 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": 27 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. |
| GET | PaymentPreAuthorize/ |
| Retrieve all of the PaymentPreAuthorize objects. | |
Retrieve all of the PaymentPreAuthorize objects. GET PaymentPreAuthorize/ 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": 17,
"createdByUserName": "Sample Text Data"
}
]
} | |
| GET | 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 PaymentPreAuthorize/Paged 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": 18,
"paymentMethodName": "Sample Text Data",
"amount": 200.5,
"transactionToken": "123kjsf90832fwf",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 9,
"createdByUserName": "Sample Text Data"
}
]
}
} | |
| GET | 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 PaymentPreAuthorize/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"paymentMethodId": 24,
"paymentMethodName": "Sample Text Data",
"amount": 200.5,
"transactionToken": "123kjsf90832fwf",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 12,
"createdByUserName": "Sample Text Data"
}
} | |
| POST | 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 PaymentPreAuthorize/
{
"paymentMethodId": 10,
"amount": 200.5,
"transactionToken": "123kjsf90832fwf",
"createdByUserId": 2
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"paymentMethodId": 15,
"paymentMethodName": "Sample Text Data",
"amount": 200.5,
"transactionToken": "123kjsf90832fwf",
"created": "2021-04-26T15:25:27.587Z",
"createdByUserId": 12,
"createdByUserName": "Sample Text Data"
}
]
}
} | |
| POST | PaymentPreAuthorize/Capture |
| Performs a full 'Capture' for the pre-authorization transaction and creates the Payment. | |