PhoeniXGate API
Version: 1.0
BasePath:/api
All rights reserved. Copyright © 2019 Phoenix Managed Networks.
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
(authenticateGet)
Consumes
This API call consumes the following media types via the request header:
Request headers
Query parameters
provider (optional)
Query Parameter —
State (optional)
Query Parameter —
oauth_token (optional)
Query Parameter —
oauth_verifier (optional)
Query Parameter —
UserName (optional)
Query Parameter —
Password (optional)
Query Parameter —
RememberMe (optional)
Query Parameter —
Continue (optional)
Query Parameter —
nonce (optional)
Query Parameter —
uri (optional)
Query Parameter —
response (optional)
Query Parameter —
qop (optional)
Query Parameter —
nc (optional)
Query Parameter —
cnonce (optional)
Query Parameter —
UseTokenCookie (optional)
Query Parameter —
AccessToken (optional)
Query Parameter —
AccessTokenSecret (optional)
Query Parameter —
Meta (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"UserName" : "UserName",
"RefreshToken" : "RefreshToken",
"ResponseStatus" : {
"Errors" : [ {
"Meta" : { },
"Message" : "Message",
"ErrorCode" : "ErrorCode",
"FieldName" : "FieldName"
}, {
"Meta" : { },
"Message" : "Message",
"ErrorCode" : "ErrorCode",
"FieldName" : "FieldName"
} ],
"Message" : "Message",
"StackTrace" : "StackTrace",
"ErrorCode" : "ErrorCode"
},
"UserId" : "UserId",
"DisplayName" : "DisplayName",
"ReferrerUrl" : "ReferrerUrl",
"SessionId" : "SessionId",
"BearerToken" : "BearerToken"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
AuthenticateResponse
(authenticatePost)
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Query parameters
provider (optional)
Query Parameter —
State (optional)
Query Parameter —
oauth_token (optional)
Query Parameter —
oauth_verifier (optional)
Query Parameter —
UserName (optional)
Query Parameter —
Password (optional)
Query Parameter —
RememberMe (optional)
Query Parameter —
Continue (optional)
Query Parameter —
nonce (optional)
Query Parameter —
uri (optional)
Query Parameter —
response (optional)
Query Parameter —
qop (optional)
Query Parameter —
nc (optional)
Query Parameter —
cnonce (optional)
Query Parameter —
UseTokenCookie (optional)
Query Parameter —
AccessToken (optional)
Query Parameter —
AccessTokenSecret (optional)
Query Parameter —
Meta (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"UserName" : "UserName",
"RefreshToken" : "RefreshToken",
"ResponseStatus" : {
"Errors" : [ {
"Meta" : { },
"Message" : "Message",
"ErrorCode" : "ErrorCode",
"FieldName" : "FieldName"
}, {
"Meta" : { },
"Message" : "Message",
"ErrorCode" : "ErrorCode",
"FieldName" : "FieldName"
} ],
"Message" : "Message",
"StackTrace" : "StackTrace",
"ErrorCode" : "ErrorCode"
},
"UserId" : "UserId",
"DisplayName" : "DisplayName",
"ReferrerUrl" : "ReferrerUrl",
"SessionId" : "SessionId",
"BearerToken" : "BearerToken"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
AuthenticateResponse
Up
delete /customers/{customerKeys}
Deletes one or more 'pending', 'active' or 'inactive' customers for the merchant requester that match the comma-separated list of keys. (deleteCustomerscustomerKeysDelete)
Deletes one or more 'pending', 'active' or 'inactive' customers for the merchant requester that match the comma-separated list of keys.
Path parameters
customersKeys (required)
Path Parameter — A comma-separated list of customer keys to be deleted. format: int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
Up
get /customers/{customerKey}
Get customer info (getCustomercustomerKeyGet)
Get customer info
Path parameters
CustomerKey (required)
Path Parameter — Unique identifier assigned to the customer record by the system at the time the customer record is created. format: int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"CreationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"MerchantKey" : 6,
"SelfLink" : "SelfLink",
"DefaultContactLink" : "DefaultContactLink",
"PaymentTokensLink" : "PaymentTokensLink",
"CustomerKey" : 0,
"ShippingAddressLink" : "ShippingAddressLink",
"CustomerID" : "CustomerID",
"CustomerName" : "CustomerName",
"BillingAddressLink" : "BillingAddressLink",
"ActivationStatus" : "ActivationStatus",
"LastUpdateTimestamp" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CustomerDetail
Get List Of All Customers Of A Merchant (getCustomersGet)
Get List Of All Customers Of A Merchant
Consumes
This API call consumes the following media types via the request header:
Request headers
Query parameters
SortField (optional)
Query Parameter — The field name by which the records will be sorted. Default is 'CustomerId'.
IncludeDeleted (optional)
Query Parameter — Whether to include deleted records in the response, defaults to false.
SortDirection (optional)
Query Parameter — The direction in which the records will be sorted. Default is 'asc'.
PageSize (optional)
Query Parameter — The number of records per page. Default is 20. format: int32
PageNumber (optional)
Query Parameter — The page number to fetch. Default is 1. format: int32
Return type
Example data
Content-Type: application/json
{
"CreationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"MerchantKey" : 6,
"SelfLink" : "SelfLink",
"DefaultContactLink" : "DefaultContactLink",
"PaymentTokensLink" : "PaymentTokensLink",
"CustomerKey" : 0,
"ShippingAddressLink" : "ShippingAddressLink",
"CustomerID" : "CustomerID",
"CustomerName" : "CustomerName",
"BillingAddressLink" : "BillingAddressLink",
"ActivationStatus" : "ActivationStatus",
"LastUpdateTimestamp" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CustomerDetail
Up
patch /customers/{customerKey}
Updates a customer for a merchant (patchCustomercustomerKeyUpdate)
Updates a customer for a merchant
Path parameters
CustomerKey (required)
Path Parameter — The key of the customer to be edited. format: int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"CreationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"MerchantKey" : 6,
"SelfLink" : "SelfLink",
"DefaultContactLink" : "DefaultContactLink",
"PaymentTokensLink" : "PaymentTokensLink",
"CustomerKey" : 0,
"ShippingAddressLink" : "ShippingAddressLink",
"CustomerID" : "CustomerID",
"CustomerName" : "CustomerName",
"BillingAddressLink" : "BillingAddressLink",
"ActivationStatus" : "ActivationStatus",
"LastUpdateTimestamp" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CustomerDetail
Create a new active-status customer for a merchant (postCustomerPost)
Create a new active-status customer for a merchant
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"CreationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"MerchantKey" : 6,
"SelfLink" : "SelfLink",
"DefaultContactLink" : "DefaultContactLink",
"PaymentTokensLink" : "PaymentTokensLink",
"CustomerKey" : 0,
"ShippingAddressLink" : "ShippingAddressLink",
"CustomerID" : "CustomerID",
"CustomerName" : "CustomerName",
"BillingAddressLink" : "BillingAddressLink",
"ActivationStatus" : "ActivationStatus",
"LastUpdateTimestamp" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CustomerDetail
Up
put /customers/{customerKey}
Replaces a customer for a merchant (putCustomercustomerKeyCreate)
Replaces a customer for a merchant
Path parameters
CustomerKey (required)
Path Parameter — The key of the customer to be edited. format: int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"CreationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"MerchantKey" : 6,
"SelfLink" : "SelfLink",
"DefaultContactLink" : "DefaultContactLink",
"PaymentTokensLink" : "PaymentTokensLink",
"CustomerKey" : 0,
"ShippingAddressLink" : "ShippingAddressLink",
"CustomerID" : "CustomerID",
"CustomerName" : "CustomerName",
"BillingAddressLink" : "BillingAddressLink",
"ActivationStatus" : "ActivationStatus",
"LastUpdateTimestamp" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CustomerDetail
Up
delete /customfields/{customFieldKeys}
Deletes one or more 'pending', 'active' or 'inactive' custom field for the merchant requester that match the comma-separated list of keys. (deleteCustomFieldscustomFieldKeysDelete)
Deletes one or more 'pending', 'active' or 'inactive' custom field for the merchant requester that match the comma-separated list of keys.
Path parameters
customFieldKeys (required)
Path Parameter — A comma-separated list of custom field keys to be deleted. format: int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
Gets a collection of 'pending', 'active' and 'inactive' and possibly 'deleted' custom fields for the merchant requester. (getAllCustomFieldsGet)
Gets a collection of 'pending', 'active' and 'inactive' and possibly 'deleted' custom fields for the merchant requester.
Consumes
This API call consumes the following media types via the request header:
Request headers
Query parameters
IncludedDeleted (optional)
Query Parameter — Whether to include deleted records in the response, defaults to false.
Return type
Example data
Content-Type: application/json
[ {
"RegularExpression" : "RegularExpression",
"DisplayOnVTReceipt" : true,
"Description" : "Description",
"IsNumeric" : true,
"Position" : 7,
"DisplayOnReports" : true,
"DisplayOnHpp" : true,
"ReadOnlyOnHpp" : true,
"MaxValue" : 5.637376656633329,
"MaxLength" : 2,
"ActivationStatus" : "Pending",
"Name" : "Name",
"DecimalPlaces" : 1,
"IsRequired" : true,
"VisibleOnHpp" : true,
"MerchantKey" : 6,
"MinValue" : 5.962133916683182,
"ErrorMessage" : "ErrorMessage",
"Key" : 0
}, {
"RegularExpression" : "RegularExpression",
"DisplayOnVTReceipt" : true,
"Description" : "Description",
"IsNumeric" : true,
"Position" : 7,
"DisplayOnReports" : true,
"DisplayOnHpp" : true,
"ReadOnlyOnHpp" : true,
"MaxValue" : 5.637376656633329,
"MaxLength" : 2,
"ActivationStatus" : "Pending",
"Name" : "Name",
"DecimalPlaces" : 1,
"IsRequired" : true,
"VisibleOnHpp" : true,
"MerchantKey" : 6,
"MinValue" : 5.962133916683182,
"ErrorMessage" : "ErrorMessage",
"Key" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
get /customfields/{Keys}
Gets a one or more 'pending', 'active', 'inactive' or 'deleted' custom fields for the merchant requester that match the comma-separated list of keys. (getCustomFieldsKeysGet)
Gets a one or more 'pending', 'active', 'inactive' or 'deleted' custom fields for the merchant requester that match the comma-separated list of keys.
Path parameters
Keys (required)
Path Parameter — A comma-separated list of custom field keys to be returned. If no keys are specified, all applicable custom fields will be returned. format: int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
[ {
"RegularExpression" : "RegularExpression",
"DisplayOnVTReceipt" : true,
"Description" : "Description",
"IsNumeric" : true,
"Position" : 7,
"DisplayOnReports" : true,
"DisplayOnHpp" : true,
"ReadOnlyOnHpp" : true,
"MaxValue" : 5.637376656633329,
"MaxLength" : 2,
"ActivationStatus" : "Pending",
"Name" : "Name",
"DecimalPlaces" : 1,
"IsRequired" : true,
"VisibleOnHpp" : true,
"MerchantKey" : 6,
"MinValue" : 5.962133916683182,
"ErrorMessage" : "ErrorMessage",
"Key" : 0
}, {
"RegularExpression" : "RegularExpression",
"DisplayOnVTReceipt" : true,
"Description" : "Description",
"IsNumeric" : true,
"Position" : 7,
"DisplayOnReports" : true,
"DisplayOnHpp" : true,
"ReadOnlyOnHpp" : true,
"MaxValue" : 5.637376656633329,
"MaxLength" : 2,
"ActivationStatus" : "Pending",
"Name" : "Name",
"DecimalPlaces" : 1,
"IsRequired" : true,
"VisibleOnHpp" : true,
"MerchantKey" : 6,
"MinValue" : 5.962133916683182,
"ErrorMessage" : "ErrorMessage",
"Key" : 0
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
patch /customfields/{Key}
Updates a single custom field for the merchant requester with only the data provided. (patchCustomFieldKeyUpdate)
Updates a single custom field for the merchant requester with only the data provided.
Path parameters
Key (required)
Path Parameter — The key of the custom field to be edited. format: int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"RegularExpression" : "RegularExpression",
"DisplayOnVTReceipt" : true,
"Description" : "Description",
"IsNumeric" : true,
"Position" : 7,
"DisplayOnReports" : true,
"DisplayOnHpp" : true,
"ReadOnlyOnHpp" : true,
"MaxValue" : 5.637376656633329,
"MaxLength" : 2,
"ActivationStatus" : "Pending",
"Name" : "Name",
"DecimalPlaces" : 1,
"IsRequired" : true,
"VisibleOnHpp" : true,
"MerchantKey" : 6,
"MinValue" : 5.962133916683182,
"ErrorMessage" : "ErrorMessage",
"Key" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CustomFieldResponse
Creates a new custom field that can be either 'pending' or 'active'. (postCustomFieldPost)
Creates a new custom field that can be either 'pending' or 'active'.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"RegularExpression" : "RegularExpression",
"DisplayOnVTReceipt" : true,
"Description" : "Description",
"IsNumeric" : true,
"Position" : 7,
"DisplayOnReports" : true,
"DisplayOnHpp" : true,
"ReadOnlyOnHpp" : true,
"MaxValue" : 5.637376656633329,
"MaxLength" : 2,
"ActivationStatus" : "Pending",
"Name" : "Name",
"DecimalPlaces" : 1,
"IsRequired" : true,
"VisibleOnHpp" : true,
"MerchantKey" : 6,
"MinValue" : 5.962133916683182,
"ErrorMessage" : "ErrorMessage",
"Key" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CustomFieldResponse
Up
put /customfields/{Key}
Updates a single custom field for the merchant requester by updating all fields to match the request (effectively, this replaces the resource, see PATCH to edit individual values). Please supply all values. (putCustomFieldKeyCreate)
Updates a single custom field for the merchant requester by updating all fields to match the request (effectively, this replaces the resource, see PATCH to edit individual values). Please supply all values.
Path parameters
Key (required)
Path Parameter — The key of the custom field to be edited. format: int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"RegularExpression" : "RegularExpression",
"DisplayOnVTReceipt" : true,
"Description" : "Description",
"IsNumeric" : true,
"Position" : 7,
"DisplayOnReports" : true,
"DisplayOnHpp" : true,
"ReadOnlyOnHpp" : true,
"MaxValue" : 5.637376656633329,
"MaxLength" : 2,
"ActivationStatus" : "Pending",
"Name" : "Name",
"DecimalPlaces" : 1,
"IsRequired" : true,
"VisibleOnHpp" : true,
"MerchantKey" : 6,
"MinValue" : 5.962133916683182,
"ErrorMessage" : "ErrorMessage",
"Key" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CustomFieldResponse
Up
delete /merchants/{merchantKey}/tokens/cards/{tokens}
Deletes one or more card tokens that match the comma-separated list of keys. (deleteCardTokensmerchantKeytokenscardstokensDelete)
Deletes one or more card tokens that match the comma-separated list of keys.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Tokens (required)
Path Parameter — A comma-separated list of card tokens to be deleted.
Consumes
This API call consumes the following media types via the request header:
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
Up
delete /merchants/{merchantKey}/tokens/checks/{tokens}
Deletes one or more check tokens that match the comma-separated list of keys. (deleteCheckTokensmerchantKeytokenscheckstokensDelete)
Deletes one or more check tokens that match the comma-separated list of keys.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Tokens (required)
Path Parameter — A comma-separated list of check tokens to be deleted.
Consumes
This API call consumes the following media types via the request header:
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
Up
delete /merchants/{merchantKey}/customers/{customerKey}/contracts/{contractKeys}
Delete one or more contracts. (deleteContractsmerchantKeycustomerscustomerKeycontractscontractKeysDelete)
Delete one or more contracts.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
CustomerKey (required)
Path Parameter — The customer key. format: Int32
ContractKeys (required)
Path Parameter — A comma separated list of contract keys. Limit 10. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
Up
delete /merchants/{merchantKeys}
Deletes one or more merchants that match the comma-separated list of keys. (deleteMerchantsmerchantKeysDelete)
Deletes one or more merchants that match the comma-separated list of keys.
Path parameters
MerchantKeys (required)
Path Parameter — A comma-separated list of merchant keys to be deleted. format: int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
Up
get /merchants/{merchantKey}/tokens/cards/{token}
Gets a card token for the merchant. (getCardTokenmerchantKeytokenscardstokenGet)
Gets a card token for the merchant.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Token (required)
Path Parameter — The card token.
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"CardNumber" : "CardNumber",
"StreetAddress" : "StreetAddress",
"MerchantKey" : 0,
"ExpirationDate" : "ExpirationDate",
"CardType" : "CardType",
"CustomerKey" : 6,
"PostalCode" : "PostalCode",
"NameOnCard" : "NameOnCard",
"Token" : "Token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CardTokenDetail
Up
get /merchants/{merchantKey}/tokens/cards
Gets a collection of card tokens for the merchant. (getCardTokensmerchantKeytokenscardsGet)
Gets a collection of card tokens for the merchant.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Query parameters
CustomerKey (optional)
Query Parameter — Constrain the records returned to those occurring on or after this value. Default is to apply no constraint. format: Int32
BeginningDate (optional)
Query Parameter — Constrain the records returned to those occurring on or after this value. Default is to apply no constraint. format: date-time
EndingDate (optional)
Query Parameter — Constrain the records returned to those occurring on or before this value. Default is to apply no constraint. format: date-time
SortField (optional)
Query Parameter — The field by which the records will be sorted. Default is 'Date'.
SortDirection (optional)
Query Parameter — The direction in which the records will be sorted. Default is 'asc'.
PageSize (optional)
Query Parameter — The number of records per page. Default is 20. format: int32
PageNumber (optional)
Query Parameter — The page number to fetch. Default is 1. format: int32
Return type
Example data
Content-Type: application/json
[ {
"CardNumber" : "CardNumber",
"StreetAddress" : "StreetAddress",
"MerchantKey" : 0,
"ExpirationDate" : "ExpirationDate",
"CardType" : "CardType",
"CustomerKey" : 6,
"PostalCode" : "PostalCode",
"NameOnCard" : "NameOnCard",
"Token" : "Token"
}, {
"CardNumber" : "CardNumber",
"StreetAddress" : "StreetAddress",
"MerchantKey" : 0,
"ExpirationDate" : "ExpirationDate",
"CardType" : "CardType",
"CustomerKey" : 6,
"PostalCode" : "PostalCode",
"NameOnCard" : "NameOnCard",
"Token" : "Token"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
get /merchants/{merchantKey}/tokens/checks/{token}
Gets a check token for the merchant. (getCheckTokenmerchantKeytokenscheckstokenGet)
Gets a check token for the merchant.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Token (required)
Path Parameter — The check token.
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"NameOnCheck" : "NameOnCheck",
"RoutingNumber" : "RoutingNumber",
"MerchantKey" : 1,
"CheckType" : "Personal",
"CustomerKey" : 5,
"Token" : "Token",
"AccountType" : "Checking",
"AccountNumber" : "AccountNumber"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CheckTokenDetail
Up
get /merchants/{merchantKey}/tokens/checks
Gets a collection of check tokens for the merchant. (getCheckTokensmerchantKeytokenschecksGet)
Gets a collection of check tokens for the merchant.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Query parameters
CustomerKey (optional)
Query Parameter — Constrain the records returned to those occurring on or after this value. Default is to apply no constraint. format: Int32
BeginningDate (optional)
Query Parameter — Constrain the records returned to those occurring on or after this value. Default is to apply no constraint. format: date-time
EndingDate (optional)
Query Parameter — Constrain the records returned to those occurring on or before this value. Default is to apply no constraint. format: date-time
SortField (optional)
Query Parameter — The field by which the records will be sorted. Default is 'Date'.
SortDirection (optional)
Query Parameter — The direction in which the records will be sorted. Default is 'asc'.
PageSize (optional)
Query Parameter — The number of records per page. Default is 20. format: int32
PageNumber (optional)
Query Parameter — The page number to fetch. Default is 1. format: int32
Return type
Example data
Content-Type: application/json
[ {
"NameOnCheck" : "NameOnCheck",
"RoutingNumber" : "RoutingNumber",
"MerchantKey" : 1,
"CheckType" : "Personal",
"CustomerKey" : 5,
"Token" : "Token",
"AccountType" : "Checking",
"AccountNumber" : "AccountNumber"
}, {
"NameOnCheck" : "NameOnCheck",
"RoutingNumber" : "RoutingNumber",
"MerchantKey" : 1,
"CheckType" : "Personal",
"CustomerKey" : 5,
"Token" : "Token",
"AccountType" : "Checking",
"AccountNumber" : "AccountNumber"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
get /merchants/{merchantKey}/customers/{customerKey}/contracts/{contractKeys}
Get details for one or more contracts. (getContractsmerchantKeycustomerscustomerKeycontractscontractKeysGet)
Get details for one or more contracts.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
CustomerKey (required)
Path Parameter — The customer key. format: Int32
ContractKeys (required)
Path Parameter — A comma separated list of contract keys. Limit 10. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"BillingInterval" : 5,
"FailureInterval" : 7,
"EmailCustomerFailure" : true,
"CustomerKey" : 1,
"Token" : "Token",
"NumberBillsToDate" : 1,
"ActivationStatus" : "ActivationStatus",
"MaxAmount" : 2.027123023002322,
"NumberFailures" : 1,
"StartDate" : "2000-01-23T04:56:07.000+00:00",
"TaxAmount" : 9.301444243932576,
"MerchantContractName" : "MerchantContractName",
"ContractKey" : 0,
"EmailMerchantFailure" : true,
"MaxFailures" : 2,
"FailurePeriod" : "FailurePeriod",
"BillAmount" : 5.962133916683182,
"AmountBillsToDate" : 7.386281948385884,
"BillingPeriod" : "BillingPeriod",
"MerchantContractId" : "MerchantContractId",
"NumberPayments" : 1,
"TotalAmount" : 3.616076749251911,
"NextBillDate" : "2000-01-23T04:56:07.000+00:00",
"EmailCustomer" : true,
"EndDate" : "2000-01-23T04:56:07.000+00:00",
"EmailMerchant" : true,
"CustomFields" : [ {
"Value" : "Value",
"Key" : 4
}, {
"Value" : "Value",
"Key" : 4
} ],
"MerchantKey" : 6,
"EmailCustomerReceiptOption" : "EmailCustomerReceiptOption"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
ContractDetail
Up
get /merchants/{merchantKey}/customers/{customerKey}/contracts
Get all contract details for a customer. (getCustomerContractsmerchantKeycustomerscustomerKeycontractsGet)
Get all contract details for a customer.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
CustomerKey (required)
Path Parameter — The customer key. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"BillingInterval" : 5,
"FailureInterval" : 7,
"EmailCustomerFailure" : true,
"CustomerKey" : 1,
"Token" : "Token",
"NumberBillsToDate" : 1,
"ActivationStatus" : "ActivationStatus",
"MaxAmount" : 2.027123023002322,
"NumberFailures" : 1,
"StartDate" : "2000-01-23T04:56:07.000+00:00",
"TaxAmount" : 9.301444243932576,
"MerchantContractName" : "MerchantContractName",
"ContractKey" : 0,
"EmailMerchantFailure" : true,
"MaxFailures" : 2,
"FailurePeriod" : "FailurePeriod",
"BillAmount" : 5.962133916683182,
"AmountBillsToDate" : 7.386281948385884,
"BillingPeriod" : "BillingPeriod",
"MerchantContractId" : "MerchantContractId",
"NumberPayments" : 1,
"TotalAmount" : 3.616076749251911,
"NextBillDate" : "2000-01-23T04:56:07.000+00:00",
"EmailCustomer" : true,
"EndDate" : "2000-01-23T04:56:07.000+00:00",
"EmailMerchant" : true,
"CustomFields" : [ {
"Value" : "Value",
"Key" : 4
}, {
"Value" : "Value",
"Key" : 4
} ],
"MerchantKey" : 6,
"EmailCustomerReceiptOption" : "EmailCustomerReceiptOption"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
ContractDetail
Up
get /merchants/{merchantKey}/contracts
Get all contract details for a merchant. (getMerchantContractsmerchantKeycontractsGet)
Get all contract details for a merchant.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"BillingInterval" : 5,
"FailureInterval" : 7,
"EmailCustomerFailure" : true,
"CustomerKey" : 1,
"Token" : "Token",
"NumberBillsToDate" : 1,
"ActivationStatus" : "ActivationStatus",
"MaxAmount" : 2.027123023002322,
"NumberFailures" : 1,
"StartDate" : "2000-01-23T04:56:07.000+00:00",
"TaxAmount" : 9.301444243932576,
"MerchantContractName" : "MerchantContractName",
"ContractKey" : 0,
"EmailMerchantFailure" : true,
"MaxFailures" : 2,
"FailurePeriod" : "FailurePeriod",
"BillAmount" : 5.962133916683182,
"AmountBillsToDate" : 7.386281948385884,
"BillingPeriod" : "BillingPeriod",
"MerchantContractId" : "MerchantContractId",
"NumberPayments" : 1,
"TotalAmount" : 3.616076749251911,
"NextBillDate" : "2000-01-23T04:56:07.000+00:00",
"EmailCustomer" : true,
"EndDate" : "2000-01-23T04:56:07.000+00:00",
"EmailMerchant" : true,
"CustomFields" : [ {
"Value" : "Value",
"Key" : 4
}, {
"Value" : "Value",
"Key" : 4
} ],
"MerchantKey" : 6,
"EmailCustomerReceiptOption" : "EmailCustomerReceiptOption"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
ContractDetail
Up
get /merchants/{merchantKey}
Gets a single merchant entity matching the merchant key provided. (getMerchantmerchantKeyGet)
Gets a single merchant entity matching the merchant key provided.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant to fetch. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"EnableOfflineBatch" : true,
"DefaultUserKey" : 1,
"AllowEmulator" : true,
"MerchantConfigurations" : {
"AccessSettings" : {
"BinManagementApi" : true,
"DialIn" : true,
"Internet" : true
},
"MerchantVirtualTerminalSettings" : {
"AutoSettleMerchantEmail" : true,
"EnableOfflineBatch" : true,
"RequireInvoice" : true,
"ResellerOnlyOrderDataDefaultsMenu" : true,
"VirtualTerminalDutyAmount" : true,
"VirtualTerminalAllowRepeat" : true,
"VirtualTerminalCustomer" : true,
"VirtualTerminalShippingAmount" : true,
"VirtualTerminalPrintTwoReceipts" : true,
"VirtualTerminalTipAmount" : true,
"VirtualTerminalRecurringBilling" : true,
"VirtualTerminalPhone" : true,
"VirtualTerminalZip" : true,
"ResellerOnlyCustomFieldsMenu" : true,
"ResellerOnlyHostedPaymentPageMenu" : true,
"VirtualTerminalCreditAccess" : true,
"RequireZipCode" : true,
"VirtualTerminalState" : true,
"EnableEmulator" : true,
"VirtualTerminalStreet" : true,
"VirtualTerminalCity" : true,
"ResellerOnlyFraudControlHeldLogMenus" : true,
"InvoiceDuplicate" : true,
"EnableHostedPage" : true,
"AuthEdit" : true,
"VirtualTerminalLevel3Amount" : true,
"VirtualTerminalInvNum" : true,
"VirtualTerminalPONum" : true,
"VirtualTerminalCommercialCard" : true,
"VirtualTerminalEmail" : true,
"VirtualTerminalAutoTaxAmount" : 5.637377,
"ApplyLevel2DefaultsToApi" : true,
"ResellerOnlyFraudControlSettingsMenu" : true,
"VirtualTerminalEmailReceipts" : true,
"LimitToDebit" : true,
"VirtualTerminalTaxAmount" : true,
"RequireNameOnCard" : true,
"ResellerOnlyEmulatorMenu" : true,
"EnableFraud" : true,
"VirtualTerminalConvenienceAmount" : true,
"RequireLevelII" : true,
"ReceiptCapture" : true,
"ImageCapture" : true,
"VirtualTerminalCustomerID" : true,
"RequireShipping" : true,
"CardVerification" : {
"AVIssuerUnavail" : true,
"AVAddNotVerifiableGlobal" : true,
"CVNoData" : true,
"AVNotRequested" : true,
"AVZipOnly" : true,
"AVInvalidAddZip" : true,
"AVNoMatch" : true,
"AVUnregCode" : true,
"CVNoMatch" : true,
"AVAddNotVerifiable" : true,
"CVUnregCode" : true,
"AVServUnsupported" : true,
"AVNoData" : true,
"CVNotPresent" : true,
"CVNotProcessed" : true,
"CVNoDataFromIssuer" : true,
"AVVerUnavail" : true,
"AVAddOnly" : true,
"AVExactMatch" : true,
"CVMatch" : true
},
"EnableGsaBinCheck" : true,
"VirtualTerminalAutoCalcTax" : true,
"CollectLevel3" : true
},
"SecuritySettings" : {
"VoidLevel" : "VoidLevel",
"BatchesLevel" : "BatchesLevel",
"RecurringBillingLevel" : "RecurringBillingLevel",
"SaleLevel" : "SaleLevel",
"ReportsLevel" : "ReportsLevel",
"CurrentBatchLevel" : "CurrentBatchLevel",
"CreditLevel" : "CreditLevel",
"InquireLevel" : "InquireLevel",
"RedeemLevel" : "RedeemLevel",
"AdjustLevel" : "AdjustLevel",
"ToolsLevel" : "ToolsLevel",
"ReloadLevel" : "ReloadLevel",
"PreAuthLevel" : "PreAuthLevel",
"ActivateLevel" : "ActivateLevel",
"RefundLevel" : "RefundLevel",
"AdminLevel" : "AdminLevel",
"ChangeSecurityLevel" : "ChangeSecurityLevel",
"PreferenceLevel" : "PreferenceLevel",
"DeactivateLevel" : "DeactivateLevel",
"SettleLevel" : "SettleLevel",
"FraudLevel" : "FraudLevel",
"ForceAuthLevel" : "ForceAuthLevel"
}
},
"BusinessInformationLink" : "BusinessInformationLink",
"RequirePNRef" : true,
"MerchantId" : "MerchantId",
"ForceDuplicate" : true,
"ActivationStatus" : "Pending",
"AllowHostedPage" : true,
"PrimaryContactLink" : "PrimaryContactLink",
"MerchantName" : "MerchantName",
"PrimaryContactKey" : 5,
"ProcessorProfilesLink" : "ProcessorProfilesLink",
"AutoCloseBatchHour" : "2000-01-23T04:56:07.000+00:00",
"LimitToDebit" : true,
"EnableFraud" : true,
"AlternateMerchantId" : "AlternateMerchantId",
"DefaultUserLink" : "DefaultUserLink",
"CreationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"SelfLink" : "SelfLink",
"ResellerKey" : 6,
"ResellerLink" : "ResellerLink",
"MerchantKey" : 0,
"AddressInformationLink" : "AddressInformationLink",
"AutoCloseBatch" : true,
"IsTestMerchant" : true,
"CollectLevel3" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
MerchantDetail
Get a list of merchants for the reseller request. (getMerchantsGet)
Get a list of merchants for the reseller request.
Consumes
This API call consumes the following media types via the request header:
Request headers
Query parameters
MerchantName (optional)
Query Parameter — Filters to a 'contains' match on the merchant name.
MerchantId (optional)
Query Parameter — Filters to an exact match of the merchant id.
SortField (optional)
Query Parameter — The field name by which the records will be sorted. Default is 'Merchant Name'.
IncludeDeleted (optional)
Query Parameter — Whether to include deleted records in the response, defaults to false.
SortDirection (optional)
Query Parameter — The direction in which the records will be sorted. Default is 'asc'.
PageSize (optional)
Query Parameter — The number of records per page. Default is 20. format: int32
PageNumber (optional)
Query Parameter — The page number to fetch. Default is 1. format: int32
Return type
Example data
Content-Type: application/json
{
"Pagination" : {
"TotalRecordCount" : 1,
"PageSize" : 6,
"CurrentPageNumber" : 0
},
"Merchants" : [ {
"EnableOfflineBatch" : true,
"DefaultUserKey" : 1,
"AllowEmulator" : true,
"MerchantConfigurations" : {
"AccessSettings" : {
"BinManagementApi" : true,
"DialIn" : true,
"Internet" : true
},
"MerchantVirtualTerminalSettings" : {
"AutoSettleMerchantEmail" : true,
"EnableOfflineBatch" : true,
"RequireInvoice" : true,
"ResellerOnlyOrderDataDefaultsMenu" : true,
"VirtualTerminalDutyAmount" : true,
"VirtualTerminalAllowRepeat" : true,
"VirtualTerminalCustomer" : true,
"VirtualTerminalShippingAmount" : true,
"VirtualTerminalPrintTwoReceipts" : true,
"VirtualTerminalTipAmount" : true,
"VirtualTerminalRecurringBilling" : true,
"VirtualTerminalPhone" : true,
"VirtualTerminalZip" : true,
"ResellerOnlyCustomFieldsMenu" : true,
"ResellerOnlyHostedPaymentPageMenu" : true,
"VirtualTerminalCreditAccess" : true,
"RequireZipCode" : true,
"VirtualTerminalState" : true,
"EnableEmulator" : true,
"VirtualTerminalStreet" : true,
"VirtualTerminalCity" : true,
"ResellerOnlyFraudControlHeldLogMenus" : true,
"InvoiceDuplicate" : true,
"EnableHostedPage" : true,
"AuthEdit" : true,
"VirtualTerminalLevel3Amount" : true,
"VirtualTerminalInvNum" : true,
"VirtualTerminalPONum" : true,
"VirtualTerminalCommercialCard" : true,
"VirtualTerminalEmail" : true,
"VirtualTerminalAutoTaxAmount" : 5.637377,
"ApplyLevel2DefaultsToApi" : true,
"ResellerOnlyFraudControlSettingsMenu" : true,
"VirtualTerminalEmailReceipts" : true,
"LimitToDebit" : true,
"VirtualTerminalTaxAmount" : true,
"RequireNameOnCard" : true,
"ResellerOnlyEmulatorMenu" : true,
"EnableFraud" : true,
"VirtualTerminalConvenienceAmount" : true,
"RequireLevelII" : true,
"ReceiptCapture" : true,
"ImageCapture" : true,
"VirtualTerminalCustomerID" : true,
"RequireShipping" : true,
"CardVerification" : {
"AVIssuerUnavail" : true,
"AVAddNotVerifiableGlobal" : true,
"CVNoData" : true,
"AVNotRequested" : true,
"AVZipOnly" : true,
"AVInvalidAddZip" : true,
"AVNoMatch" : true,
"AVUnregCode" : true,
"CVNoMatch" : true,
"AVAddNotVerifiable" : true,
"CVUnregCode" : true,
"AVServUnsupported" : true,
"AVNoData" : true,
"CVNotPresent" : true,
"CVNotProcessed" : true,
"CVNoDataFromIssuer" : true,
"AVVerUnavail" : true,
"AVAddOnly" : true,
"AVExactMatch" : true,
"CVMatch" : true
},
"EnableGsaBinCheck" : true,
"VirtualTerminalAutoCalcTax" : true,
"CollectLevel3" : true
},
"SecuritySettings" : {
"VoidLevel" : "VoidLevel",
"BatchesLevel" : "BatchesLevel",
"RecurringBillingLevel" : "RecurringBillingLevel",
"SaleLevel" : "SaleLevel",
"ReportsLevel" : "ReportsLevel",
"CurrentBatchLevel" : "CurrentBatchLevel",
"CreditLevel" : "CreditLevel",
"InquireLevel" : "InquireLevel",
"RedeemLevel" : "RedeemLevel",
"AdjustLevel" : "AdjustLevel",
"ToolsLevel" : "ToolsLevel",
"ReloadLevel" : "ReloadLevel",
"PreAuthLevel" : "PreAuthLevel",
"ActivateLevel" : "ActivateLevel",
"RefundLevel" : "RefundLevel",
"AdminLevel" : "AdminLevel",
"ChangeSecurityLevel" : "ChangeSecurityLevel",
"PreferenceLevel" : "PreferenceLevel",
"DeactivateLevel" : "DeactivateLevel",
"SettleLevel" : "SettleLevel",
"FraudLevel" : "FraudLevel",
"ForceAuthLevel" : "ForceAuthLevel"
}
},
"BusinessInformationLink" : "BusinessInformationLink",
"RequirePNRef" : true,
"MerchantId" : "MerchantId",
"ForceDuplicate" : true,
"ActivationStatus" : "Pending",
"AllowHostedPage" : true,
"PrimaryContactLink" : "PrimaryContactLink",
"MerchantName" : "MerchantName",
"PrimaryContactKey" : 5,
"ProcessorProfilesLink" : "ProcessorProfilesLink",
"AutoCloseBatchHour" : "2000-01-23T04:56:07.000+00:00",
"LimitToDebit" : true,
"EnableFraud" : true,
"AlternateMerchantId" : "AlternateMerchantId",
"DefaultUserLink" : "DefaultUserLink",
"CreationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"SelfLink" : "SelfLink",
"ResellerKey" : 6,
"ResellerLink" : "ResellerLink",
"MerchantKey" : 0,
"AddressInformationLink" : "AddressInformationLink",
"AutoCloseBatch" : true,
"IsTestMerchant" : true,
"CollectLevel3" : true
}, {
"EnableOfflineBatch" : true,
"DefaultUserKey" : 1,
"AllowEmulator" : true,
"MerchantConfigurations" : {
"AccessSettings" : {
"BinManagementApi" : true,
"DialIn" : true,
"Internet" : true
},
"MerchantVirtualTerminalSettings" : {
"AutoSettleMerchantEmail" : true,
"EnableOfflineBatch" : true,
"RequireInvoice" : true,
"ResellerOnlyOrderDataDefaultsMenu" : true,
"VirtualTerminalDutyAmount" : true,
"VirtualTerminalAllowRepeat" : true,
"VirtualTerminalCustomer" : true,
"VirtualTerminalShippingAmount" : true,
"VirtualTerminalPrintTwoReceipts" : true,
"VirtualTerminalTipAmount" : true,
"VirtualTerminalRecurringBilling" : true,
"VirtualTerminalPhone" : true,
"VirtualTerminalZip" : true,
"ResellerOnlyCustomFieldsMenu" : true,
"ResellerOnlyHostedPaymentPageMenu" : true,
"VirtualTerminalCreditAccess" : true,
"RequireZipCode" : true,
"VirtualTerminalState" : true,
"EnableEmulator" : true,
"VirtualTerminalStreet" : true,
"VirtualTerminalCity" : true,
"ResellerOnlyFraudControlHeldLogMenus" : true,
"InvoiceDuplicate" : true,
"EnableHostedPage" : true,
"AuthEdit" : true,
"VirtualTerminalLevel3Amount" : true,
"VirtualTerminalInvNum" : true,
"VirtualTerminalPONum" : true,
"VirtualTerminalCommercialCard" : true,
"VirtualTerminalEmail" : true,
"VirtualTerminalAutoTaxAmount" : 5.637377,
"ApplyLevel2DefaultsToApi" : true,
"ResellerOnlyFraudControlSettingsMenu" : true,
"VirtualTerminalEmailReceipts" : true,
"LimitToDebit" : true,
"VirtualTerminalTaxAmount" : true,
"RequireNameOnCard" : true,
"ResellerOnlyEmulatorMenu" : true,
"EnableFraud" : true,
"VirtualTerminalConvenienceAmount" : true,
"RequireLevelII" : true,
"ReceiptCapture" : true,
"ImageCapture" : true,
"VirtualTerminalCustomerID" : true,
"RequireShipping" : true,
"CardVerification" : {
"AVIssuerUnavail" : true,
"AVAddNotVerifiableGlobal" : true,
"CVNoData" : true,
"AVNotRequested" : true,
"AVZipOnly" : true,
"AVInvalidAddZip" : true,
"AVNoMatch" : true,
"AVUnregCode" : true,
"CVNoMatch" : true,
"AVAddNotVerifiable" : true,
"CVUnregCode" : true,
"AVServUnsupported" : true,
"AVNoData" : true,
"CVNotPresent" : true,
"CVNotProcessed" : true,
"CVNoDataFromIssuer" : true,
"AVVerUnavail" : true,
"AVAddOnly" : true,
"AVExactMatch" : true,
"CVMatch" : true
},
"EnableGsaBinCheck" : true,
"VirtualTerminalAutoCalcTax" : true,
"CollectLevel3" : true
},
"SecuritySettings" : {
"VoidLevel" : "VoidLevel",
"BatchesLevel" : "BatchesLevel",
"RecurringBillingLevel" : "RecurringBillingLevel",
"SaleLevel" : "SaleLevel",
"ReportsLevel" : "ReportsLevel",
"CurrentBatchLevel" : "CurrentBatchLevel",
"CreditLevel" : "CreditLevel",
"InquireLevel" : "InquireLevel",
"RedeemLevel" : "RedeemLevel",
"AdjustLevel" : "AdjustLevel",
"ToolsLevel" : "ToolsLevel",
"ReloadLevel" : "ReloadLevel",
"PreAuthLevel" : "PreAuthLevel",
"ActivateLevel" : "ActivateLevel",
"RefundLevel" : "RefundLevel",
"AdminLevel" : "AdminLevel",
"ChangeSecurityLevel" : "ChangeSecurityLevel",
"PreferenceLevel" : "PreferenceLevel",
"DeactivateLevel" : "DeactivateLevel",
"SettleLevel" : "SettleLevel",
"FraudLevel" : "FraudLevel",
"ForceAuthLevel" : "ForceAuthLevel"
}
},
"BusinessInformationLink" : "BusinessInformationLink",
"RequirePNRef" : true,
"MerchantId" : "MerchantId",
"ForceDuplicate" : true,
"ActivationStatus" : "Pending",
"AllowHostedPage" : true,
"PrimaryContactLink" : "PrimaryContactLink",
"MerchantName" : "MerchantName",
"PrimaryContactKey" : 5,
"ProcessorProfilesLink" : "ProcessorProfilesLink",
"AutoCloseBatchHour" : "2000-01-23T04:56:07.000+00:00",
"LimitToDebit" : true,
"EnableFraud" : true,
"AlternateMerchantId" : "AlternateMerchantId",
"DefaultUserLink" : "DefaultUserLink",
"CreationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"SelfLink" : "SelfLink",
"ResellerKey" : 6,
"ResellerLink" : "ResellerLink",
"MerchantKey" : 0,
"AddressInformationLink" : "AddressInformationLink",
"AutoCloseBatch" : true,
"IsTestMerchant" : true,
"CollectLevel3" : true
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
MerchantDetailResults
Up
get /merchants/{merchantKey}/processing-profiles
Get a list of processor profiles for the specified merchant. (getProcessorConfigurationsmerchantKeyprocessingProfilesGet)
Get a list of processor profiles for the specified merchant.
Path parameters
MerchantKey (required)
Path Parameter — Will return all of the processor profiles for the specified merchant (unless filtered by the optional parameters.). format: int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Query parameters
ProcessorName (optional)
Query Parameter — Will return all of the named processor profile's individual payment configurations.
PaymentConfigurationKey (optional)
Query Parameter — Will return a processor profile's specific payment configuration. format: int32
Return type
Example data
Content-Type: application/json
{
"MerchantKey" : 0,
"PaymentConfigurations" : [ {
"IsHostBasedManualSettle" : true,
"PaymentMethodKey" : 6,
"IsHostBased" : true,
"PaymentType" : "PaymentType",
"Settings" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ]
}, {
"IsHostBasedManualSettle" : true,
"PaymentMethodKey" : 6,
"IsHostBased" : true,
"PaymentType" : "PaymentType",
"Settings" : [ {
"Value" : "Value",
"Key" : "Key"
}, {
"Value" : "Value",
"Key" : "Key"
} ]
} ],
"ProcessorName" : "ProcessorName"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
ProcessorConfiguration
Up
patch /merchants/{merchantKey}/tokens/cards/{token}
Updates a card token for the merchant. (patchCardTokenmerchantKeytokenscardstokenUpdate)
Updates a card token for the merchant.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Token (required)
Path Parameter — The card token.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"CardNumber" : "CardNumber",
"StreetAddress" : "StreetAddress",
"MerchantKey" : 0,
"ExpirationDate" : "ExpirationDate",
"CardType" : "CardType",
"CustomerKey" : 6,
"PostalCode" : "PostalCode",
"NameOnCard" : "NameOnCard",
"Token" : "Token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CardTokenDetail
Up
patch /merchants/{merchantKey}/tokens/checks/{token}
Updates a check token for the merchant. (patchCheckTokenmerchantKeytokenscheckstokenUpdate)
Updates a check token for the merchant.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Token (required)
Path Parameter — The check token.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"NameOnCheck" : "NameOnCheck",
"RoutingNumber" : "RoutingNumber",
"MerchantKey" : 1,
"CheckType" : "Personal",
"CustomerKey" : 5,
"Token" : "Token",
"AccountType" : "Checking",
"AccountNumber" : "AccountNumber"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CheckTokenDetail
Up
patch /merchants/{merchantKey}/customers/{customerKey}/contracts/{contractKey}
Update a recurring billing contract for a customer. (patchContractmerchantKeycustomerscustomerKeycontractscontractKeyUpdate)
Update a recurring billing contract for a customer.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
CustomerKey (required)
Path Parameter — The customer key. format: Int32
ContractKey (required)
Path Parameter — The key of the contract to patch. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"BillingInterval" : 5,
"FailureInterval" : 7,
"EmailCustomerFailure" : true,
"CustomerKey" : 1,
"Token" : "Token",
"NumberBillsToDate" : 1,
"ActivationStatus" : "ActivationStatus",
"MaxAmount" : 2.027123023002322,
"NumberFailures" : 1,
"StartDate" : "2000-01-23T04:56:07.000+00:00",
"TaxAmount" : 9.301444243932576,
"MerchantContractName" : "MerchantContractName",
"ContractKey" : 0,
"EmailMerchantFailure" : true,
"MaxFailures" : 2,
"FailurePeriod" : "FailurePeriod",
"BillAmount" : 5.962133916683182,
"AmountBillsToDate" : 7.386281948385884,
"BillingPeriod" : "BillingPeriod",
"MerchantContractId" : "MerchantContractId",
"NumberPayments" : 1,
"TotalAmount" : 3.616076749251911,
"NextBillDate" : "2000-01-23T04:56:07.000+00:00",
"EmailCustomer" : true,
"EndDate" : "2000-01-23T04:56:07.000+00:00",
"EmailMerchant" : true,
"CustomFields" : [ {
"Value" : "Value",
"Key" : 4
}, {
"Value" : "Value",
"Key" : 4
} ],
"MerchantKey" : 6,
"EmailCustomerReceiptOption" : "EmailCustomerReceiptOption"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
ContractDetail
Up
patch /merchants/{merchantKey}
Replaces a merchant. (patchMerchantmerchantKeyUpdate)
Replaces a merchant.
Path parameters
MerchantKey (required)
Path Parameter — The merchant key. format: int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
Up
post /merchants/{merchantKey}/tokens/cards
Creates a card token for the merchant. (postCardTokenmerchantKeytokenscardsPost)
Creates a card token for the merchant.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"CardNumber" : "CardNumber",
"StreetAddress" : "StreetAddress",
"MerchantKey" : 0,
"ExpirationDate" : "ExpirationDate",
"CardType" : "CardType",
"CustomerKey" : 6,
"PostalCode" : "PostalCode",
"NameOnCard" : "NameOnCard",
"Token" : "Token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CardTokenDetail
Up
post /merchants/{merchantKey}/tokens/checks
Creates a check token for the merchant. (postCheckTokenmerchantKeytokenschecksPost)
Creates a check token for the merchant.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
CustomerKey (required)
Path Parameter — The key of the customer. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"NameOnCheck" : "NameOnCheck",
"RoutingNumber" : "RoutingNumber",
"MerchantKey" : 1,
"CheckType" : "Personal",
"CustomerKey" : 5,
"Token" : "Token",
"AccountType" : "Checking",
"AccountNumber" : "AccountNumber"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CheckTokenDetail
Up
post /merchants/{merchantKey}/customers/{customerKey}/contracts
Create a new recurring billing contract for a customer. (postContractmerchantKeycustomerscustomerKeycontractsPost)
Create a new recurring billing contract for a customer.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
CustomerKey (required)
Path Parameter — The customer key. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"BillingInterval" : 5,
"FailureInterval" : 7,
"EmailCustomerFailure" : true,
"CustomerKey" : 1,
"Token" : "Token",
"NumberBillsToDate" : 1,
"ActivationStatus" : "ActivationStatus",
"MaxAmount" : 2.027123023002322,
"NumberFailures" : 1,
"StartDate" : "2000-01-23T04:56:07.000+00:00",
"TaxAmount" : 9.301444243932576,
"MerchantContractName" : "MerchantContractName",
"ContractKey" : 0,
"EmailMerchantFailure" : true,
"MaxFailures" : 2,
"FailurePeriod" : "FailurePeriod",
"BillAmount" : 5.962133916683182,
"AmountBillsToDate" : 7.386281948385884,
"BillingPeriod" : "BillingPeriod",
"MerchantContractId" : "MerchantContractId",
"NumberPayments" : 1,
"TotalAmount" : 3.616076749251911,
"NextBillDate" : "2000-01-23T04:56:07.000+00:00",
"EmailCustomer" : true,
"EndDate" : "2000-01-23T04:56:07.000+00:00",
"EmailMerchant" : true,
"CustomFields" : [ {
"Value" : "Value",
"Key" : 4
}, {
"Value" : "Value",
"Key" : 4
} ],
"MerchantKey" : 6,
"EmailCustomerReceiptOption" : "EmailCustomerReceiptOption"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
ContractDetail
Up
post /merchants/{merchantKey}/users
Creates a new gateway user for the specified merchant. (postMerchantGatewayUsermerchantKeyusersPost)
Creates a new gateway user for the specified merchant.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"Timezone" : "Timezone",
"IsLockoutEnabled" : true,
"UserName" : "UserName",
"FirstName" : "FirstName",
"Address2" : "Address2",
"StateCode" : "AK",
"PostalCode" : "PostalCode",
"Address1" : "Address1",
"City" : "City",
"EmailAddress" : "EmailAddress",
"IsTwoFactorEnabled" : true,
"PhoneNumber" : "PhoneNumber",
"Id" : 0,
"LastName" : "LastName",
"ShouldChangePasswordOnNextLogin" : true,
"CountryCode" : "USA",
"Password" : "Password"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
GatewayUserResponse
Creates a new merchant. (postMerchantPost)
Creates a new merchant.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
Up
post /merchants/{merchantKey}/tokens
Creates a card or check token from the PnRef. (postPnRefTokenmerchantKeytokensPost)
Creates a card or check token from the PnRef.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"CardToken" : {
"CardNumber" : "CardNumber",
"StreetAddress" : "StreetAddress",
"MerchantKey" : 0,
"ExpirationDate" : "ExpirationDate",
"CardType" : "CardType",
"CustomerKey" : 6,
"PostalCode" : "PostalCode",
"NameOnCard" : "NameOnCard",
"Token" : "Token"
},
"CheckToken" : {
"NameOnCheck" : "NameOnCheck",
"RoutingNumber" : "RoutingNumber",
"MerchantKey" : 1,
"CheckType" : "Personal",
"CustomerKey" : 5,
"Token" : "Token",
"AccountType" : "Checking",
"AccountNumber" : "AccountNumber"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
PnRefTokenDetail
Up
put /merchants/{merchantKey}/tokens/cards/{token}
Replaces a card token for the merchant. (putCardTokenmerchantKeytokenscardstokenCreate)
Replaces a card token for the merchant.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Token (required)
Path Parameter — The card token.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"CardNumber" : "CardNumber",
"StreetAddress" : "StreetAddress",
"MerchantKey" : 0,
"ExpirationDate" : "ExpirationDate",
"CardType" : "CardType",
"CustomerKey" : 6,
"PostalCode" : "PostalCode",
"NameOnCard" : "NameOnCard",
"Token" : "Token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CardTokenDetail
Up
put /merchants/{merchantKey}/tokens/checks/{token}
Replaces a check token for the merchant. (putCheckTokenmerchantKeytokenscheckstokenCreate)
Replaces a check token for the merchant.
Path parameters
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
Token (required)
Path Parameter — The check token.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"NameOnCheck" : "NameOnCheck",
"RoutingNumber" : "RoutingNumber",
"MerchantKey" : 1,
"CheckType" : "Personal",
"CustomerKey" : 5,
"Token" : "Token",
"AccountType" : "Checking",
"AccountNumber" : "AccountNumber"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
CheckTokenDetail
Up
put /merchants/{merchantKey}/customers/{customerKey}/contracts/{contractKey}
Replace a recurring billing contract for a customer. (putContractmerchantKeycustomerscustomerKeycontractscontractKeyCreate)
Replace a recurring billing contract for a customer.
Path parameters
ContractKey (required)
Path Parameter — The key of the contract to replace. format: Int32
MerchantKey (required)
Path Parameter — The key of the merchant. format: Int32
CustomerKey (required)
Path Parameter — The customer key. format: Int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"BillingInterval" : 5,
"FailureInterval" : 7,
"EmailCustomerFailure" : true,
"CustomerKey" : 1,
"Token" : "Token",
"NumberBillsToDate" : 1,
"ActivationStatus" : "ActivationStatus",
"MaxAmount" : 2.027123023002322,
"NumberFailures" : 1,
"StartDate" : "2000-01-23T04:56:07.000+00:00",
"TaxAmount" : 9.301444243932576,
"MerchantContractName" : "MerchantContractName",
"ContractKey" : 0,
"EmailMerchantFailure" : true,
"MaxFailures" : 2,
"FailurePeriod" : "FailurePeriod",
"BillAmount" : 5.962133916683182,
"AmountBillsToDate" : 7.386281948385884,
"BillingPeriod" : "BillingPeriod",
"MerchantContractId" : "MerchantContractId",
"NumberPayments" : 1,
"TotalAmount" : 3.616076749251911,
"NextBillDate" : "2000-01-23T04:56:07.000+00:00",
"EmailCustomer" : true,
"EndDate" : "2000-01-23T04:56:07.000+00:00",
"EmailMerchant" : true,
"CustomFields" : [ {
"Value" : "Value",
"Key" : 4
}, {
"Value" : "Value",
"Key" : 4
} ],
"MerchantKey" : 6,
"EmailCustomerReceiptOption" : "EmailCustomerReceiptOption"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
ContractDetail
Up
put /merchants/{merchantKey}
Replaces a merchant. (putMerchantmerchantKeyCreate)
Replaces a merchant.
Path parameters
MerchantKey (required)
Path Parameter — The merchant key. format: int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
Up
delete /quickpayments/merchants/{merchantKey}/keys
Deletes the merchant's QuickPayments Key. (postQuickPaymentsKeyRequestmerchantsmerchantKeykeysDelete)
Deletes the merchant's QuickPayments Key.
Path parameters
MerchantKey (required)
Path Parameter — Indicates the merchant key for the QuickPayments Key. format: int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"QuickPaymentsKey" : "QuickPaymentsKey"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
QuickPaymentsKeyResponse
Up
get /quickpayments/merchants/{merchantKey}/keys
Fetches the merchant's QuickPayments Key. (postQuickPaymentsKeyRequestmerchantsmerchantKeykeysGet)
Fetches the merchant's QuickPayments Key.
Path parameters
MerchantKey (required)
Path Parameter — Indicates the merchant key for the QuickPayments Key. format: int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"QuickPaymentsKey" : "QuickPaymentsKey"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
QuickPaymentsKeyResponse
Up
post /quickpayments/merchants/{merchantKey}/keys
Creates a new QuickPayments Key, if one does not already exist for the merchant. (postQuickPaymentsKeyRequestmerchantsmerchantKeykeysPost)
Creates a new QuickPayments Key, if one does not already exist for the merchant.
Path parameters
MerchantKey (required)
Path Parameter — Indicates the merchant key for the QuickPayments Key. format: int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"QuickPaymentsKey" : "QuickPaymentsKey"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
QuickPaymentsKeyResponse
Up
post /quickpayments/qp-tokens
Creates a one-time use, short-lived, QuickPayments Token for use in a subsequent transaction. (postQuickPaymentsTokenRequestqpTokensPost)
Creates a one-time use, short-lived, QuickPayments Token for use in a subsequent transaction.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"QuickPaymentsToken" : "QuickPaymentsToken"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
QuickPaymentsTokenResponse
Up
post /quickpayments/tokens
Creates a token from a QuickPayments token. (postTokenRequesttokensPost)
Creates a token from a QuickPayments token.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"Token" : "Token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
TokenResponse
Up
delete /registers/{registerKeys}
Deletes one or more 'pending', 'active' or 'inactive' register for the merchant requester that match the comma-separated list of keys. (deleteRegistersregisterKeysDelete)
Deletes one or more 'pending', 'active' or 'inactive' register for the merchant requester that match the comma-separated list of keys.
Path parameters
registerKeys (required)
Path Parameter — A comma-separated list of register keys to be deleted. format: int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
No Content
Up
get /registers/{registerKey}
Gets a register by key for the merchant requester. (getRegisterregisterKeyGet)
Gets a register by key for the merchant requester.
Path parameters
RegisterKey (required)
Path Parameter — The key of the register to be returned. format: int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"RegisterName" : "RegisterName",
"RegisterNumber" : "RegisterNumber",
"TerminalNumber2" : "TerminalNumber2",
"MerchantKey" : 6,
"ProcessorId" : "ProcessorId",
"RegisterKey" : 0,
"ActivationStatus" : "ActivationStatus",
"TerminalNumber" : "TerminalNumber",
"LastUpdateTimestamp" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
RegisterDetail
Gets a collection of registers for the merchant requester. (getRegistersGet)
Gets a collection of registers for the merchant requester.
Consumes
This API call consumes the following media types via the request header:
Request headers
Query parameters
SortField (optional)
Query Parameter — The field name by which the records will be sorted. Default is 'RegisterNumber'.
IncludeDeleted (optional)
Query Parameter — Whether to include deleted records in the response, defaults to false.
SortDirection (optional)
Query Parameter — The direction in which the records will be sorted. Default is 'asc'.
PageSize (optional)
Query Parameter — The number of records per page. Default is 20. format: int32
PageNumber (optional)
Query Parameter — The page number to fetch. Default is 1. format: int32
Return type
Example data
Content-Type: application/json
[ {
"RegisterName" : "RegisterName",
"RegisterNumber" : "RegisterNumber",
"TerminalNumber2" : "TerminalNumber2",
"MerchantKey" : 6,
"ProcessorId" : "ProcessorId",
"RegisterKey" : 0,
"ActivationStatus" : "ActivationStatus",
"TerminalNumber" : "TerminalNumber",
"LastUpdateTimestamp" : "2000-01-23T04:56:07.000+00:00"
}, {
"RegisterName" : "RegisterName",
"RegisterNumber" : "RegisterNumber",
"TerminalNumber2" : "TerminalNumber2",
"MerchantKey" : 6,
"ProcessorId" : "ProcessorId",
"RegisterKey" : 0,
"ActivationStatus" : "ActivationStatus",
"TerminalNumber" : "TerminalNumber",
"LastUpdateTimestamp" : "2000-01-23T04:56:07.000+00:00"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
patch /registers/{registerKey}
Updates a register for the merchant requester with only the data provided. (patchRegisterregisterKeyUpdate)
Updates a register for the merchant requester with only the data provided.
Path parameters
registerKey (required)
Path Parameter — The key of the custom field to be edited. format: int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"RegisterName" : "RegisterName",
"RegisterNumber" : "RegisterNumber",
"TerminalNumber2" : "TerminalNumber2",
"MerchantKey" : 6,
"ProcessorId" : "ProcessorId",
"RegisterKey" : 0,
"ActivationStatus" : "ActivationStatus",
"TerminalNumber" : "TerminalNumber",
"LastUpdateTimestamp" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
RegisterDetail
Creates a register for the merchant requester. (postRegisterPost)
Creates a register for the merchant requester.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"RegisterName" : "RegisterName",
"RegisterNumber" : "RegisterNumber",
"TerminalNumber2" : "TerminalNumber2",
"MerchantKey" : 6,
"ProcessorId" : "ProcessorId",
"RegisterKey" : 0,
"ActivationStatus" : "ActivationStatus",
"TerminalNumber" : "TerminalNumber",
"LastUpdateTimestamp" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
RegisterDetail
Up
put /registers/{registerKey}
Updates a single register for the merchant requester by updating all fields to match the request (effectively, this replaces the resource, see PATCH to edit individual values). Please supply all values. (putRegisterregisterKeyCreate)
Updates a single register for the merchant requester by updating all fields to match the request (effectively, this replaces the resource, see PATCH to edit individual values). Please supply all values.
Path parameters
RegisterKey (required)
Path Parameter — The key of the register to be edited. format: int32
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"RegisterName" : "RegisterName",
"RegisterNumber" : "RegisterNumber",
"TerminalNumber2" : "TerminalNumber2",
"MerchantKey" : 6,
"ProcessorId" : "ProcessorId",
"RegisterKey" : 0,
"ActivationStatus" : "ActivationStatus",
"TerminalNumber" : "TerminalNumber",
"LastUpdateTimestamp" : "2000-01-23T04:56:07.000+00:00"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
RegisterDetail
Up
get /reports/settlements/
Get a list of settlement batches based on your search criteria. (getSettlementBatchessettlementsGet)
Get a list of settlement batches based on your search criteria.
Consumes
This API call consumes the following media types via the request header:
Request headers
Query parameters
BeginDate (required)
Query Parameter — Beginning date of the settlement batch record query. format: date-time
EndDate (optional)
Query Parameter — End date of the settlement batch record query. format: date-time
MerchantKey (optional)
Query Parameter — The key of the merchant of the settlement batches. format: date-time
SortField (optional)
Query Parameter — The field name by which the records will be sorted. Default is 'BatchDate'.
SortDirection (optional)
Query Parameter — The direction in which the records will be sorted. Default is 'asc'.
PageSize (optional)
Query Parameter — The number of records per page. Default is 20. format: int32
PageNumber (optional)
Query Parameter — The page number to fetch. Default is 1. format: int32
Return type
Example data
Content-Type: application/json
[ {
"Pagination" : {
"TotalRecordCount" : 1,
"PageSize" : 6,
"CurrentPageNumber" : 0
},
"MerchantName" : "MerchantName",
"Batches" : [ {
"Processor" : "Processor",
"Message" : "Message",
"BatchId" : "BatchId",
"MID" : "MID",
"ReturnAmount" : 1.4658129805029452,
"BatchDate" : "2000-01-23T04:56:07.000+00:00",
"TotalAmount" : 5.962133916683182,
"SaleAmount" : 6.027456183070403,
"TransactionCount" : 0
}, {
"Processor" : "Processor",
"Message" : "Message",
"BatchId" : "BatchId",
"MID" : "MID",
"ReturnAmount" : 1.4658129805029452,
"BatchDate" : "2000-01-23T04:56:07.000+00:00",
"TotalAmount" : 5.962133916683182,
"SaleAmount" : 6.027456183070403,
"TransactionCount" : 0
} ]
}, {
"Pagination" : {
"TotalRecordCount" : 1,
"PageSize" : 6,
"CurrentPageNumber" : 0
},
"MerchantName" : "MerchantName",
"Batches" : [ {
"Processor" : "Processor",
"Message" : "Message",
"BatchId" : "BatchId",
"MID" : "MID",
"ReturnAmount" : 1.4658129805029452,
"BatchDate" : "2000-01-23T04:56:07.000+00:00",
"TotalAmount" : 5.962133916683182,
"SaleAmount" : 6.027456183070403,
"TransactionCount" : 0
}, {
"Processor" : "Processor",
"Message" : "Message",
"BatchId" : "BatchId",
"MID" : "MID",
"ReturnAmount" : 1.4658129805029452,
"BatchDate" : "2000-01-23T04:56:07.000+00:00",
"TotalAmount" : 5.962133916683182,
"SaleAmount" : 6.027456183070403,
"TransactionCount" : 0
} ]
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
get /reports/settlements/{batchId}
Gets a list of detailed transaction data by batch id. (getSettlementDetailsettlementsbatchIdGet)
Gets a list of detailed transaction data by batch id.
Path parameters
BatchId (required)
Path Parameter — The batch id to query.
Consumes
This API call consumes the following media types via the request header:
Request headers
Query parameters
SortField (optional)
Query Parameter — The field name by which the records will be sorted. Default is 'BeginDate'.
SortDirection (optional)
Query Parameter — The direction in which the records will be sorted. Default is 'asc'.
PageSize (optional)
Query Parameter — The number of records per page. Default is 20. format: int32
PageNumber (optional)
Query Parameter — The page number to fetch. Default is 1. format: int32
Return type
Example data
Content-Type: application/json
{
"Transactions" : [ {
"TransactionType" : "TransactionType",
"Processor" : "Processor",
"TransactionFinishTimestamp" : "2000-01-23T04:56:07.000+00:00",
"VoidFlag" : "VoidFlag",
"OriginalTransactionPnRef" : 5,
"CardDetail" : {
"CashBackAmount" : 9.301444243932576,
"AvsResponse" : "AvsResponse",
"Token" : "Token",
"Level3Amount" : 2.027123023002322,
"TotalAmount" : 7.061401241503109,
"HostReferenceNumber" : "HostReferenceNumber",
"SurchargeAmount" : 3.616076749251911,
"AvsResponseText" : "AvsResponseText",
"AccountType" : "AccountType",
"ApprovalCode" : "ApprovalCode",
"CvvResponseText" : "CvvResponseText",
"CvvResponse" : "CvvResponse",
"ResultText" : "ResultText",
"CardExpiration" : "CardExpiration",
"AuthorizationAmount" : 5.637376656633329,
"MaskedPAN" : "MaskedPAN",
"NameOnCard" : "NameOnCard",
"TipAmount" : 2.3021358869347655,
"ResultCode" : "ResultCode"
},
"PnRef" : 0,
"AuthorizationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"SettleFlag" : "SettleFlag",
"CheckDetail" : {
"DateOfBirth" : "DateOfBirth",
"NameOnCheck" : "NameOnCheck",
"SocialSecurityNumber" : "SocialSecurityNumber",
"StateCode" : "StateCode",
"Token" : "Token",
"HostReferenceNumber" : "HostReferenceNumber",
"CheckNumber" : "CheckNumber",
"ResultMessage" : "ResultMessage",
"AccountType" : "AccountType",
"DriversLicenseNumber" : "DriversLicenseNumber",
"EmailAddress" : "EmailAddress",
"AccountNumber" : "AccountNumber",
"RoutingNumber" : "RoutingNumber",
"HostApproval" : "HostApproval",
"ResultText" : "ResultText",
"CheckType" : "CheckType",
"PhoneNumber" : "PhoneNumber",
"TertiaryResultMessage" : "TertiaryResultMessage",
"CheckAmount" : 4.145608029883936,
"ResultCode" : "ResultCode",
"SecondaryResultMessage" : "SecondaryResultMessage"
},
"SequenceNumber" : "SequenceNumber",
"SettlementTimestamp" : "2000-01-23T04:56:07.000+00:00",
"PaymentType" : "PaymentType",
"InvoiceNumber" : "InvoiceNumber",
"CashDetail" : {
"CashAmount" : 7.386281948385884
},
"UserName" : "UserName",
"TransactionTimestamp" : "2000-01-23T04:56:07.000+00:00",
"BatchNumber" : "BatchNumber",
"IP" : "IP",
"BatchId" : "BatchId",
"Adjusted" : "Adjusted",
"SettlementMessage" : "SettlementMessage",
"CustomerId" : "CustomerId",
"ProcessorResponseTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ResellerKey" : 1,
"BatchSequenceNumber" : "BatchSequenceNumber",
"RegisterNumber" : "RegisterNumber",
"CustomerReference" : "CustomerReference",
"CustomFields" : [ {
"Value" : "Value",
"Name" : "Name"
}, {
"Value" : "Value",
"Name" : "Name"
} ],
"MerchantKey" : 6,
"ProcessorRequestTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ReversalFlag" : "ReversalFlag"
}, {
"TransactionType" : "TransactionType",
"Processor" : "Processor",
"TransactionFinishTimestamp" : "2000-01-23T04:56:07.000+00:00",
"VoidFlag" : "VoidFlag",
"OriginalTransactionPnRef" : 5,
"CardDetail" : {
"CashBackAmount" : 9.301444243932576,
"AvsResponse" : "AvsResponse",
"Token" : "Token",
"Level3Amount" : 2.027123023002322,
"TotalAmount" : 7.061401241503109,
"HostReferenceNumber" : "HostReferenceNumber",
"SurchargeAmount" : 3.616076749251911,
"AvsResponseText" : "AvsResponseText",
"AccountType" : "AccountType",
"ApprovalCode" : "ApprovalCode",
"CvvResponseText" : "CvvResponseText",
"CvvResponse" : "CvvResponse",
"ResultText" : "ResultText",
"CardExpiration" : "CardExpiration",
"AuthorizationAmount" : 5.637376656633329,
"MaskedPAN" : "MaskedPAN",
"NameOnCard" : "NameOnCard",
"TipAmount" : 2.3021358869347655,
"ResultCode" : "ResultCode"
},
"PnRef" : 0,
"AuthorizationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"SettleFlag" : "SettleFlag",
"CheckDetail" : {
"DateOfBirth" : "DateOfBirth",
"NameOnCheck" : "NameOnCheck",
"SocialSecurityNumber" : "SocialSecurityNumber",
"StateCode" : "StateCode",
"Token" : "Token",
"HostReferenceNumber" : "HostReferenceNumber",
"CheckNumber" : "CheckNumber",
"ResultMessage" : "ResultMessage",
"AccountType" : "AccountType",
"DriversLicenseNumber" : "DriversLicenseNumber",
"EmailAddress" : "EmailAddress",
"AccountNumber" : "AccountNumber",
"RoutingNumber" : "RoutingNumber",
"HostApproval" : "HostApproval",
"ResultText" : "ResultText",
"CheckType" : "CheckType",
"PhoneNumber" : "PhoneNumber",
"TertiaryResultMessage" : "TertiaryResultMessage",
"CheckAmount" : 4.145608029883936,
"ResultCode" : "ResultCode",
"SecondaryResultMessage" : "SecondaryResultMessage"
},
"SequenceNumber" : "SequenceNumber",
"SettlementTimestamp" : "2000-01-23T04:56:07.000+00:00",
"PaymentType" : "PaymentType",
"InvoiceNumber" : "InvoiceNumber",
"CashDetail" : {
"CashAmount" : 7.386281948385884
},
"UserName" : "UserName",
"TransactionTimestamp" : "2000-01-23T04:56:07.000+00:00",
"BatchNumber" : "BatchNumber",
"IP" : "IP",
"BatchId" : "BatchId",
"Adjusted" : "Adjusted",
"SettlementMessage" : "SettlementMessage",
"CustomerId" : "CustomerId",
"ProcessorResponseTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ResellerKey" : 1,
"BatchSequenceNumber" : "BatchSequenceNumber",
"RegisterNumber" : "RegisterNumber",
"CustomerReference" : "CustomerReference",
"CustomFields" : [ {
"Value" : "Value",
"Name" : "Name"
}, {
"Value" : "Value",
"Name" : "Name"
} ],
"MerchantKey" : 6,
"ProcessorRequestTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ReversalFlag" : "ReversalFlag"
} ],
"Pagination" : {
"TotalRecordCount" : 1,
"PageSize" : 6,
"CurrentPageNumber" : 0
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
TransactionDetailResults
Up
get /reports/transactions/
Get a list of transactions based on your search criteria. (getTransactionstransactionsGet)
Get a list of transactions based on your search criteria.
Consumes
This API call consumes the following media types via the request header:
Request headers
Query parameters
BeginDate (required)
Query Parameter — Beginning date of the transaction record query. format: date-time
EndDate (optional)
Query Parameter — End date of the transaction record query. format: date-time
TransactionTypes (optional)
Query Parameter — If provided, only those transactions matching the TransactionTypes will be included.
InvoiceNumber (optional)
Query Parameter — The invoice ID that was included in the original transaction. If provided, only those transactions with matching invoiceId will be included.
SettlementFlag (optional)
Query Parameter — The SettlementFlag parameter allows you to choose whether settled or unsettled transactions are included in the results.
SettleBeginDate (optional)
Query Parameter — Beginning date of the settlement search window. format: date-time
SettleEndDate (optional)
Query Parameter — End date of the settlement search window. format: date-time
SettleMessage (optional)
Query Parameter — The settlement ID or message returned from the host.
SettleStatus (optional)
Query Parameter — Allows you to choose whether settled or unsettled transactions are included in the results.
Username (optional)
Query Parameter — The user who originated the transactions. If provided, only those transactions created by the matching User will be included.
ResultCodes (optional)
Query Parameter — If provided, only those transactions matching the Result will be included.
Register (optional)
Query Parameter — The register (if applicable) on which the transaction was processed
ApprovalCode (optional)
Query Parameter — The approval code is a alphanumeric value generated by the issuing bank. This field may also be used by payment processors to return error messages.
Note: Approval codes are not necessarily unique and there is potential (rare) for more than one record to be returned.
NameOnInstrument (optional)
Query Parameter — For card transactions, this is the name on the card. For check transactions, this is the name on the check. If provided, only those transactions with a matching instrument name will be included.
CustomerId (optional)
Query Parameter — Merchant-assigned identifier of the customer associated with the transaction(s)
ContractId (optional)
Query Parameter — Merchant-assigned identifier of the contract associated with the transaction(s)
ContractKey (optional)
Query Parameter — System-assigned identifier of the contract associated with the transaction(s) format: int32
SortField (optional)
Query Parameter — The field name by which the records will be sorted. Default is 'BeginDate'.
TotalAmountMax (optional)
Query Parameter — Specifies the maximum amount value of the transactions being searched for. In DDDDDD.CC format format: double
TotalAmountMin (optional)
Query Parameter — Specifies the minimum amount value of the transactions being searched for. In DDDDDD.CC format format: double
PaymentTypes (optional)
Query Parameter — If provided, only those transactions matching the Payment Type will be included.
CardNumber (optional)
Query Parameter — If provided, only those transactions with an exact Card Number match will be included.
CheckTypes (optional)
Query Parameter — If provided, only those transactions matching the Check Type will be included.
CheckAccountTypes (optional)
Query Parameter — If provided, only those transactions matching the Check Account Type will be included.
CheckAccountNumber (optional)
Query Parameter — If provided, only those transactions with an exact Check Account Number match will be included. format: int32
CheckRoutingNumber (optional)
Query Parameter — If provided, only those transactions with an exact Check Routing Number match will be included. format: int32
SortDirection (optional)
Query Parameter — The direction in which the records will be sorted. Default is 'asc'.
PageSize (optional)
Query Parameter — The number of records per page. Default is 20. format: int32
PageNumber (optional)
Query Parameter — The page number to fetch. Default is 1. format: int32
Return type
Example data
Content-Type: application/json
[ {
"TransactionType" : "TransactionType",
"Processor" : "Processor",
"TransactionFinishTimestamp" : "2000-01-23T04:56:07.000+00:00",
"VoidFlag" : "VoidFlag",
"OriginalTransactionPnRef" : 5,
"CardDetail" : {
"CashBackAmount" : 9.301444243932576,
"AvsResponse" : "AvsResponse",
"Token" : "Token",
"Level3Amount" : 2.027123023002322,
"TotalAmount" : 7.061401241503109,
"HostReferenceNumber" : "HostReferenceNumber",
"SurchargeAmount" : 3.616076749251911,
"AvsResponseText" : "AvsResponseText",
"AccountType" : "AccountType",
"ApprovalCode" : "ApprovalCode",
"CvvResponseText" : "CvvResponseText",
"CvvResponse" : "CvvResponse",
"ResultText" : "ResultText",
"CardExpiration" : "CardExpiration",
"AuthorizationAmount" : 5.637376656633329,
"MaskedPAN" : "MaskedPAN",
"NameOnCard" : "NameOnCard",
"TipAmount" : 2.3021358869347655,
"ResultCode" : "ResultCode"
},
"PnRef" : 0,
"AuthorizationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"SettleFlag" : "SettleFlag",
"CheckDetail" : {
"DateOfBirth" : "DateOfBirth",
"NameOnCheck" : "NameOnCheck",
"SocialSecurityNumber" : "SocialSecurityNumber",
"StateCode" : "StateCode",
"Token" : "Token",
"HostReferenceNumber" : "HostReferenceNumber",
"CheckNumber" : "CheckNumber",
"ResultMessage" : "ResultMessage",
"AccountType" : "AccountType",
"DriversLicenseNumber" : "DriversLicenseNumber",
"EmailAddress" : "EmailAddress",
"AccountNumber" : "AccountNumber",
"RoutingNumber" : "RoutingNumber",
"HostApproval" : "HostApproval",
"ResultText" : "ResultText",
"CheckType" : "CheckType",
"PhoneNumber" : "PhoneNumber",
"TertiaryResultMessage" : "TertiaryResultMessage",
"CheckAmount" : 4.145608029883936,
"ResultCode" : "ResultCode",
"SecondaryResultMessage" : "SecondaryResultMessage"
},
"SequenceNumber" : "SequenceNumber",
"SettlementTimestamp" : "2000-01-23T04:56:07.000+00:00",
"PaymentType" : "PaymentType",
"InvoiceNumber" : "InvoiceNumber",
"CashDetail" : {
"CashAmount" : 7.386281948385884
},
"UserName" : "UserName",
"TransactionTimestamp" : "2000-01-23T04:56:07.000+00:00",
"BatchNumber" : "BatchNumber",
"IP" : "IP",
"BatchId" : "BatchId",
"Adjusted" : "Adjusted",
"SettlementMessage" : "SettlementMessage",
"CustomerId" : "CustomerId",
"ProcessorResponseTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ResellerKey" : 1,
"BatchSequenceNumber" : "BatchSequenceNumber",
"RegisterNumber" : "RegisterNumber",
"CustomerReference" : "CustomerReference",
"CustomFields" : [ {
"Value" : "Value",
"Name" : "Name"
}, {
"Value" : "Value",
"Name" : "Name"
} ],
"MerchantKey" : 6,
"ProcessorRequestTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ReversalFlag" : "ReversalFlag"
}, {
"TransactionType" : "TransactionType",
"Processor" : "Processor",
"TransactionFinishTimestamp" : "2000-01-23T04:56:07.000+00:00",
"VoidFlag" : "VoidFlag",
"OriginalTransactionPnRef" : 5,
"CardDetail" : {
"CashBackAmount" : 9.301444243932576,
"AvsResponse" : "AvsResponse",
"Token" : "Token",
"Level3Amount" : 2.027123023002322,
"TotalAmount" : 7.061401241503109,
"HostReferenceNumber" : "HostReferenceNumber",
"SurchargeAmount" : 3.616076749251911,
"AvsResponseText" : "AvsResponseText",
"AccountType" : "AccountType",
"ApprovalCode" : "ApprovalCode",
"CvvResponseText" : "CvvResponseText",
"CvvResponse" : "CvvResponse",
"ResultText" : "ResultText",
"CardExpiration" : "CardExpiration",
"AuthorizationAmount" : 5.637376656633329,
"MaskedPAN" : "MaskedPAN",
"NameOnCard" : "NameOnCard",
"TipAmount" : 2.3021358869347655,
"ResultCode" : "ResultCode"
},
"PnRef" : 0,
"AuthorizationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"SettleFlag" : "SettleFlag",
"CheckDetail" : {
"DateOfBirth" : "DateOfBirth",
"NameOnCheck" : "NameOnCheck",
"SocialSecurityNumber" : "SocialSecurityNumber",
"StateCode" : "StateCode",
"Token" : "Token",
"HostReferenceNumber" : "HostReferenceNumber",
"CheckNumber" : "CheckNumber",
"ResultMessage" : "ResultMessage",
"AccountType" : "AccountType",
"DriversLicenseNumber" : "DriversLicenseNumber",
"EmailAddress" : "EmailAddress",
"AccountNumber" : "AccountNumber",
"RoutingNumber" : "RoutingNumber",
"HostApproval" : "HostApproval",
"ResultText" : "ResultText",
"CheckType" : "CheckType",
"PhoneNumber" : "PhoneNumber",
"TertiaryResultMessage" : "TertiaryResultMessage",
"CheckAmount" : 4.145608029883936,
"ResultCode" : "ResultCode",
"SecondaryResultMessage" : "SecondaryResultMessage"
},
"SequenceNumber" : "SequenceNumber",
"SettlementTimestamp" : "2000-01-23T04:56:07.000+00:00",
"PaymentType" : "PaymentType",
"InvoiceNumber" : "InvoiceNumber",
"CashDetail" : {
"CashAmount" : 7.386281948385884
},
"UserName" : "UserName",
"TransactionTimestamp" : "2000-01-23T04:56:07.000+00:00",
"BatchNumber" : "BatchNumber",
"IP" : "IP",
"BatchId" : "BatchId",
"Adjusted" : "Adjusted",
"SettlementMessage" : "SettlementMessage",
"CustomerId" : "CustomerId",
"ProcessorResponseTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ResellerKey" : 1,
"BatchSequenceNumber" : "BatchSequenceNumber",
"RegisterNumber" : "RegisterNumber",
"CustomerReference" : "CustomerReference",
"CustomFields" : [ {
"Value" : "Value",
"Name" : "Name"
}, {
"Value" : "Value",
"Name" : "Name"
} ],
"MerchantKey" : 6,
"ProcessorRequestTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ReversalFlag" : "ReversalFlag"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
post /reports/transactions/
Get a list of transactions based on your search criteria. (getTransactionstransactionsPost)
Get a list of transactions based on your search criteria.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Query parameters
BeginDate (required)
Query Parameter — Beginning date of the transaction record query. format: date-time
EndDate (optional)
Query Parameter — End date of the transaction record query. format: date-time
TransactionTypes (optional)
Query Parameter — If provided, only those transactions matching the TransactionTypes will be included.
InvoiceNumber (optional)
Query Parameter — The invoice ID that was included in the original transaction. If provided, only those transactions with matching invoiceId will be included.
SettlementFlag (optional)
Query Parameter — The SettlementFlag parameter allows you to choose whether settled or unsettled transactions are included in the results.
SettleBeginDate (optional)
Query Parameter — Beginning date of the settlement search window. format: date-time
SettleEndDate (optional)
Query Parameter — End date of the settlement search window. format: date-time
SettleMessage (optional)
Query Parameter — The settlement ID or message returned from the host.
SettleStatus (optional)
Query Parameter — Allows you to choose whether settled or unsettled transactions are included in the results.
Username (optional)
Query Parameter — The user who originated the transactions. If provided, only those transactions created by the matching User will be included.
ResultCodes (optional)
Query Parameter — If provided, only those transactions matching the Result will be included.
Register (optional)
Query Parameter — The register (if applicable) on which the transaction was processed
ApprovalCode (optional)
Query Parameter — The approval code is a alphanumeric value generated by the issuing bank. This field may also be used by payment processors to return error messages.
Note: Approval codes are not necessarily unique and there is potential (rare) for more than one record to be returned.
NameOnInstrument (optional)
Query Parameter — For card transactions, this is the name on the card. For check transactions, this is the name on the check. If provided, only those transactions with a matching instrument name will be included.
CustomerId (optional)
Query Parameter — Merchant-assigned identifier of the customer associated with the transaction(s)
ContractId (optional)
Query Parameter — Merchant-assigned identifier of the contract associated with the transaction(s)
ContractKey (optional)
Query Parameter — System-assigned identifier of the contract associated with the transaction(s) format: int32
SortField (optional)
Query Parameter — The field name by which the records will be sorted. Default is 'BeginDate'.
TotalAmountMax (optional)
Query Parameter — Specifies the maximum amount value of the transactions being searched for. In DDDDDD.CC format format: double
TotalAmountMin (optional)
Query Parameter — Specifies the minimum amount value of the transactions being searched for. In DDDDDD.CC format format: double
PaymentTypes (optional)
Query Parameter — If provided, only those transactions matching the Payment Type will be included.
CardNumber (optional)
Query Parameter — If provided, only those transactions with an exact Card Number match will be included.
CheckTypes (optional)
Query Parameter — If provided, only those transactions matching the Check Type will be included.
CheckAccountTypes (optional)
Query Parameter — If provided, only those transactions matching the Check Account Type will be included.
CheckAccountNumber (optional)
Query Parameter — If provided, only those transactions with an exact Check Account Number match will be included. format: int32
CheckRoutingNumber (optional)
Query Parameter — If provided, only those transactions with an exact Check Routing Number match will be included. format: int32
SortDirection (optional)
Query Parameter — The direction in which the records will be sorted. Default is 'asc'.
PageSize (optional)
Query Parameter — The number of records per page. Default is 20. format: int32
PageNumber (optional)
Query Parameter — The page number to fetch. Default is 1. format: int32
Return type
Example data
Content-Type: application/json
[ {
"TransactionType" : "TransactionType",
"Processor" : "Processor",
"TransactionFinishTimestamp" : "2000-01-23T04:56:07.000+00:00",
"VoidFlag" : "VoidFlag",
"OriginalTransactionPnRef" : 5,
"CardDetail" : {
"CashBackAmount" : 9.301444243932576,
"AvsResponse" : "AvsResponse",
"Token" : "Token",
"Level3Amount" : 2.027123023002322,
"TotalAmount" : 7.061401241503109,
"HostReferenceNumber" : "HostReferenceNumber",
"SurchargeAmount" : 3.616076749251911,
"AvsResponseText" : "AvsResponseText",
"AccountType" : "AccountType",
"ApprovalCode" : "ApprovalCode",
"CvvResponseText" : "CvvResponseText",
"CvvResponse" : "CvvResponse",
"ResultText" : "ResultText",
"CardExpiration" : "CardExpiration",
"AuthorizationAmount" : 5.637376656633329,
"MaskedPAN" : "MaskedPAN",
"NameOnCard" : "NameOnCard",
"TipAmount" : 2.3021358869347655,
"ResultCode" : "ResultCode"
},
"PnRef" : 0,
"AuthorizationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"SettleFlag" : "SettleFlag",
"CheckDetail" : {
"DateOfBirth" : "DateOfBirth",
"NameOnCheck" : "NameOnCheck",
"SocialSecurityNumber" : "SocialSecurityNumber",
"StateCode" : "StateCode",
"Token" : "Token",
"HostReferenceNumber" : "HostReferenceNumber",
"CheckNumber" : "CheckNumber",
"ResultMessage" : "ResultMessage",
"AccountType" : "AccountType",
"DriversLicenseNumber" : "DriversLicenseNumber",
"EmailAddress" : "EmailAddress",
"AccountNumber" : "AccountNumber",
"RoutingNumber" : "RoutingNumber",
"HostApproval" : "HostApproval",
"ResultText" : "ResultText",
"CheckType" : "CheckType",
"PhoneNumber" : "PhoneNumber",
"TertiaryResultMessage" : "TertiaryResultMessage",
"CheckAmount" : 4.145608029883936,
"ResultCode" : "ResultCode",
"SecondaryResultMessage" : "SecondaryResultMessage"
},
"SequenceNumber" : "SequenceNumber",
"SettlementTimestamp" : "2000-01-23T04:56:07.000+00:00",
"PaymentType" : "PaymentType",
"InvoiceNumber" : "InvoiceNumber",
"CashDetail" : {
"CashAmount" : 7.386281948385884
},
"UserName" : "UserName",
"TransactionTimestamp" : "2000-01-23T04:56:07.000+00:00",
"BatchNumber" : "BatchNumber",
"IP" : "IP",
"BatchId" : "BatchId",
"Adjusted" : "Adjusted",
"SettlementMessage" : "SettlementMessage",
"CustomerId" : "CustomerId",
"ProcessorResponseTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ResellerKey" : 1,
"BatchSequenceNumber" : "BatchSequenceNumber",
"RegisterNumber" : "RegisterNumber",
"CustomerReference" : "CustomerReference",
"CustomFields" : [ {
"Value" : "Value",
"Name" : "Name"
}, {
"Value" : "Value",
"Name" : "Name"
} ],
"MerchantKey" : 6,
"ProcessorRequestTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ReversalFlag" : "ReversalFlag"
}, {
"TransactionType" : "TransactionType",
"Processor" : "Processor",
"TransactionFinishTimestamp" : "2000-01-23T04:56:07.000+00:00",
"VoidFlag" : "VoidFlag",
"OriginalTransactionPnRef" : 5,
"CardDetail" : {
"CashBackAmount" : 9.301444243932576,
"AvsResponse" : "AvsResponse",
"Token" : "Token",
"Level3Amount" : 2.027123023002322,
"TotalAmount" : 7.061401241503109,
"HostReferenceNumber" : "HostReferenceNumber",
"SurchargeAmount" : 3.616076749251911,
"AvsResponseText" : "AvsResponseText",
"AccountType" : "AccountType",
"ApprovalCode" : "ApprovalCode",
"CvvResponseText" : "CvvResponseText",
"CvvResponse" : "CvvResponse",
"ResultText" : "ResultText",
"CardExpiration" : "CardExpiration",
"AuthorizationAmount" : 5.637376656633329,
"MaskedPAN" : "MaskedPAN",
"NameOnCard" : "NameOnCard",
"TipAmount" : 2.3021358869347655,
"ResultCode" : "ResultCode"
},
"PnRef" : 0,
"AuthorizationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"SettleFlag" : "SettleFlag",
"CheckDetail" : {
"DateOfBirth" : "DateOfBirth",
"NameOnCheck" : "NameOnCheck",
"SocialSecurityNumber" : "SocialSecurityNumber",
"StateCode" : "StateCode",
"Token" : "Token",
"HostReferenceNumber" : "HostReferenceNumber",
"CheckNumber" : "CheckNumber",
"ResultMessage" : "ResultMessage",
"AccountType" : "AccountType",
"DriversLicenseNumber" : "DriversLicenseNumber",
"EmailAddress" : "EmailAddress",
"AccountNumber" : "AccountNumber",
"RoutingNumber" : "RoutingNumber",
"HostApproval" : "HostApproval",
"ResultText" : "ResultText",
"CheckType" : "CheckType",
"PhoneNumber" : "PhoneNumber",
"TertiaryResultMessage" : "TertiaryResultMessage",
"CheckAmount" : 4.145608029883936,
"ResultCode" : "ResultCode",
"SecondaryResultMessage" : "SecondaryResultMessage"
},
"SequenceNumber" : "SequenceNumber",
"SettlementTimestamp" : "2000-01-23T04:56:07.000+00:00",
"PaymentType" : "PaymentType",
"InvoiceNumber" : "InvoiceNumber",
"CashDetail" : {
"CashAmount" : 7.386281948385884
},
"UserName" : "UserName",
"TransactionTimestamp" : "2000-01-23T04:56:07.000+00:00",
"BatchNumber" : "BatchNumber",
"IP" : "IP",
"BatchId" : "BatchId",
"Adjusted" : "Adjusted",
"SettlementMessage" : "SettlementMessage",
"CustomerId" : "CustomerId",
"ProcessorResponseTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ResellerKey" : 1,
"BatchSequenceNumber" : "BatchSequenceNumber",
"RegisterNumber" : "RegisterNumber",
"CustomerReference" : "CustomerReference",
"CustomFields" : [ {
"Value" : "Value",
"Name" : "Name"
}, {
"Value" : "Value",
"Name" : "Name"
} ],
"MerchantKey" : 6,
"ProcessorRequestTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ReversalFlag" : "ReversalFlag"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Up
get /reports/transactions/{pnRefs}
Get details for one to ten transactions. (getTransactiontransactionspnRefsGet)
Get details for one to ten transactions.
Path parameters
PnRefs (required)
Path Parameter — A comma separated list of transaction reference numbers. Limit 10. format: int32
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"TransactionType" : "TransactionType",
"Processor" : "Processor",
"TransactionFinishTimestamp" : "2000-01-23T04:56:07.000+00:00",
"VoidFlag" : "VoidFlag",
"OriginalTransactionPnRef" : 5,
"CardDetail" : {
"CashBackAmount" : 9.301444243932576,
"AvsResponse" : "AvsResponse",
"Token" : "Token",
"Level3Amount" : 2.027123023002322,
"TotalAmount" : 7.061401241503109,
"HostReferenceNumber" : "HostReferenceNumber",
"SurchargeAmount" : 3.616076749251911,
"AvsResponseText" : "AvsResponseText",
"AccountType" : "AccountType",
"ApprovalCode" : "ApprovalCode",
"CvvResponseText" : "CvvResponseText",
"CvvResponse" : "CvvResponse",
"ResultText" : "ResultText",
"CardExpiration" : "CardExpiration",
"AuthorizationAmount" : 5.637376656633329,
"MaskedPAN" : "MaskedPAN",
"NameOnCard" : "NameOnCard",
"TipAmount" : 2.3021358869347655,
"ResultCode" : "ResultCode"
},
"PnRef" : 0,
"AuthorizationTimestamp" : "2000-01-23T04:56:07.000+00:00",
"SettleFlag" : "SettleFlag",
"CheckDetail" : {
"DateOfBirth" : "DateOfBirth",
"NameOnCheck" : "NameOnCheck",
"SocialSecurityNumber" : "SocialSecurityNumber",
"StateCode" : "StateCode",
"Token" : "Token",
"HostReferenceNumber" : "HostReferenceNumber",
"CheckNumber" : "CheckNumber",
"ResultMessage" : "ResultMessage",
"AccountType" : "AccountType",
"DriversLicenseNumber" : "DriversLicenseNumber",
"EmailAddress" : "EmailAddress",
"AccountNumber" : "AccountNumber",
"RoutingNumber" : "RoutingNumber",
"HostApproval" : "HostApproval",
"ResultText" : "ResultText",
"CheckType" : "CheckType",
"PhoneNumber" : "PhoneNumber",
"TertiaryResultMessage" : "TertiaryResultMessage",
"CheckAmount" : 4.145608029883936,
"ResultCode" : "ResultCode",
"SecondaryResultMessage" : "SecondaryResultMessage"
},
"SequenceNumber" : "SequenceNumber",
"SettlementTimestamp" : "2000-01-23T04:56:07.000+00:00",
"PaymentType" : "PaymentType",
"InvoiceNumber" : "InvoiceNumber",
"CashDetail" : {
"CashAmount" : 7.386281948385884
},
"UserName" : "UserName",
"TransactionTimestamp" : "2000-01-23T04:56:07.000+00:00",
"BatchNumber" : "BatchNumber",
"IP" : "IP",
"BatchId" : "BatchId",
"Adjusted" : "Adjusted",
"SettlementMessage" : "SettlementMessage",
"CustomerId" : "CustomerId",
"ProcessorResponseTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ResellerKey" : 1,
"BatchSequenceNumber" : "BatchSequenceNumber",
"RegisterNumber" : "RegisterNumber",
"CustomerReference" : "CustomerReference",
"CustomFields" : [ {
"Value" : "Value",
"Name" : "Name"
}, {
"Value" : "Value",
"Name" : "Name"
} ],
"MerchantKey" : 6,
"ProcessorRequestTimestamp" : "2000-01-23T04:56:07.000+00:00",
"ReversalFlag" : "ReversalFlag"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
TransactionDetail
Run a transaction with a card or check (createTransactionRequestPost)
Transactions may be processed using all supported payment types including Credit, Debit, Check, Cash, Gift and Loyalty. Tokens may also be used for processing against a stored payment method.
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"resultText" : "resultText",
"authCode" : "authCode",
"customFields" : [ {
"Value" : "Value",
"Name" : "Name"
}, {
"Value" : "Value",
"Name" : "Name"
} ],
"amountData" : {
"RemainingBalance" : 1.4658129805029452,
"AuthorizedAmount" : 0.8008281904610115,
"TotalAmount" : 6.027456183070403
},
"resultCode" : 5,
"pnRef" : 2,
"message" : "message",
"merchantKey" : 5,
"binData" : {
"IssuingOrg" : "IssuingOrg",
"IssuingPhone" : "IssuingPhone",
"IssuingWebsite" : "IssuingWebsite",
"Bin" : 7,
"CardType" : "CardType",
"CardBrand" : "CardBrand",
"IsCommercial" : true,
"CardCategory" : "CardCategory",
"IssuingCountry" : "IssuingCountry"
},
"validationData" : {
"avsResponseText" : "avsResponseText",
"streetMatchText" : "streetMatchText",
"zipMatchText" : "zipMatchText",
"cvResultText" : "cvResultText",
"cvResponse" : "cvResponse",
"avsResponse" : "avsResponse"
},
"token" : "token",
"hostCode" : "hostCode",
"message2" : "message2",
"message1" : "message1"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Success
Transaction
[ Jump to Methods ]
Table of Contents
Address - AddressAmountData - AmountDataAuthenticate - AuthenticateAuthenticateResponse - AuthenticateResponseBinData - BinDataBusinessInformation - BusinessInformationCardData - CardDataCardDetail - CardDetailCardTokenDetail - CardTokenDetailCardValidationData - CardValidationDataCashDetail - CashDetailCheckData - CheckDataCheckDetail - CheckDetailCheckTokenDetail - CheckTokenDetailContact - ContactContractCustomField - ContractCustomFieldContractDetail - ContractDetailCreateTransactionRequest - CreateTransactionRequestCustomField - CustomFieldCustomFieldResponse - CustomFieldResponseCustomerDetail - CustomerDetailDeleteCardTokens - DeleteCardTokensDeleteCheckTokens - DeleteCheckTokensDeleteContracts - DeleteContractsDeleteCustomFields - DeleteCustomFieldsDeleteCustomers - DeleteCustomersDeleteMerchants - DeleteMerchantsDeleteRegisters - DeleteRegistersDictionary - Dictionary<String,String>Fsa - FsaGatewayUser - GatewayUserGatewayUserResponse - GatewayUserResponseGetAllCustomFields - GetAllCustomFieldsGetCardToken - GetCardTokenGetCardTokens - GetCardTokensGetCheckToken - GetCheckTokenGetCheckTokens - GetCheckTokensGetContracts - GetContractsGetCustomFields - GetCustomFieldsGetCustomer - GetCustomerGetCustomerContracts - GetCustomerContractsGetCustomers - GetCustomersGetMerchant - GetMerchantGetMerchantContracts - GetMerchantContractsGetMerchants - GetMerchantsGetProcessorConfigurations - GetProcessorConfigurationsGetRegister - GetRegisterGetRegisters - GetRegistersGetSettlementBatches - GetSettlementBatchesGetSettlementDetail - GetSettlementDetailGetTransaction - GetTransactionGetTransactions - GetTransactionsIEnumerable - IEnumerableIEnumerable - IEnumerableInvoice - InvoiceKeyValuePair - KeyValuePair<String,String>List - ListList - ListList - ListList - ListMerchantAccessSettings - MerchantAccessSettingsMerchantCardVerificationSettings - MerchantCardVerificationSettingsMerchantConfigurations - MerchantConfigurationsMerchantDetail - MerchantDetailMerchantDetailResults - MerchantDetailResultsMerchantSecuritySettings - MerchantSecuritySettingsMerchantVirtualTerminalSettings - MerchantVirtualTerminalSettingsObject - OriginalTransaction - OriginalTransactionPaginationStats - PaginationStatsPatchCardToken - PatchCardTokenPatchCheckToken - PatchCheckTokenPatchContract - PatchContractPatchCustomField - PatchCustomFieldPatchCustomer - PatchCustomerPatchMerchant - PatchMerchantPatchRegister - PatchRegisterPaymentConfiguration - PaymentConfigurationPnRefTokenDetail - PnRefTokenDetailPostCardToken - PostCardTokenPostCheckToken - PostCheckTokenPostContract - PostContractPostCustomField - PostCustomFieldPostCustomer - PostCustomerPostMerchant - PostMerchantPostMerchantGatewayUser - PostMerchantGatewayUserPostPnRefToken - PostPnRefTokenPostQuickPaymentsKeyRequest - PostQuickPaymentsKeyRequestPostQuickPaymentsTokenRequest - PostQuickPaymentsTokenRequestPostRegister - PostRegisterPostTokenRequest - PostTokenRequestProcessorConfiguration - ProcessorConfigurationPurchaseCardData - PurchaseCardDataPurchaseCardLineItemData - PurchaseCardLineItemDataPutCardToken - PutCardTokenPutCheckToken - PutCheckTokenPutContract - PutContractPutCustomField - PutCustomFieldPutCustomer - PutCustomerPutMerchant - PutMerchantPutRegister - PutRegisterQuickPaymentsKeyResponse - QuickPaymentsKeyResponseQuickPaymentsTokenResponse - QuickPaymentsTokenResponseRegisterDetail - RegisterDetailResponseError - ResponseErrorResponseStatus - ResponseStatusSettlementBatch - SettlementBatchSettlementBatchResults - SettlementBatchResultsSignatureData - SignatureDataSoftDescriptor - SoftDescriptorTokenResponse - TokenResponseTransaction - TransactionTransactionDetail - TransactionDetailTransactionDetailResults - TransactionDetailResults
Address
StreetAddress1
String The street address, max 50 chars
StreetAddress2 (optional)
String The street address 2, max 50 chars
StreetAddress3 (optional)
String The street address 3, max 50 chars
City (optional)
StateOrProvinceCode
String The CHAR-2 USA state and CAN province codes
AK
AL
AR
AZ
CA
CO
CT
DC
DE
FL
GA
HI
IA
ID
IL
IN
KS
KY
LA
MA
MD
ME
MI
MN
MO
MS
MT
NC
ND
NE
NH
NJ
NM
NV
NY
OH
OK
OR
PA
RI
SC
SD
TN
TX
UT
VA
VT
WA
WI
WV
WY
AB
BC
MB
NB
NL
NS
NT
NU
ON
PE
QC
SK
YT
PostalCode
String The postal code, max 30 chars
CountryCode
String The ISO Alpha-3 USA or CAN country codes
USA
CAN
AmountData
AuthorizedAmount (optional)
Double The amount authorized at the processor for the transaction. When partial authorization is disabled/not-supported this amount will be the same as the totalAmount. If partial authorization is allowed and a transaction receives a partial approval, this will be the amount authorized. format: double
TotalAmount (optional)
Double The total amount of the transaction. This may be greater than the authorized amount if partial authorizations are enabled. format: double
RemainingBalance (optional)
Double For pre-paid, gift, and EBT cards this will show the balance remaining on the card when the processor returns the necessary balance data. format: double
Authenticate
provider (optional)
State (optional)
oauth_token (optional)
oauth_verifier (optional)
UserName (optional)
Password (optional)
RememberMe (optional)
Continue (optional)
nonce (optional)
uri (optional)
response (optional)
qop (optional)
nc (optional)
cnonce (optional)
UseTokenCookie (optional)
AccessToken (optional)
AccessTokenSecret (optional)
Meta (optional)
AuthenticateResponse
UserId (optional)
SessionId (optional)
UserName (optional)
DisplayName (optional)
ReferrerUrl (optional)
BearerToken (optional)
RefreshToken (optional)
ResponseStatus (optional)
Meta (optional)
BinData
Bin (optional)
Integer The BIN/first 6 digits of the card format: int32
CardBrand (optional)
String The card brand (VISA, MasterCard, American Express, etc
IssuingOrg (optional)
String The organization/bank that issued the card
CardType (optional)
String Typically debit or credit
CardCategory (optional)
String The category indicating special types of card such as corporate, purchasing, and prepaid
IssuingCountry (optional)
String The country where the card was issued
IssuingPhone (optional)
String Phone number, if available, of the issuing organization
IssuingWebsite (optional)
String Web site, if available, of the issuing organization
IsCommercial (optional)
Boolean True if the card category indicates this is a commercial/business/purchasing card which may qualify for level 2/3 rates
BusinessInformation
DbaName (optional)
String The doing business as name, max 50 chars
TelephoneNumber (optional)
String The telephone number, max 13 chars
CardData
CardNumber (optional)
String Credit card number used to uniquely identify the card owner’s account.
ExpirationDate (optional)
String Credit card date of expiration in MMYY format.
Cvv (optional)
Integer Card verification number. Note: This parameter may be required depending on the merchant’s setup. format: int32
NameOnCard (optional)
String Name of the cardholder, as displayed on the card
Pin (optional)
String The encrypted PIN-block returned by the PIN pad. The transaction will fail if an unencrypted PIN is used. Note: This information is not required for PIN-less debit transactions.
KeySerialNumber (optional)
String PIN pad serial number used in managing DUKPT PIN pads. This is required for all transactions where a pin is present
Token (optional)
String A value generated by the gateway for payment data which has been previously stored. The format of the value depends on the format selected when the payment method was originally stored.
EmvData (optional)
String The TLV (tag-length-value) string provided by the certified, emv-capable terminal. This value should not be modified before transmission.
TrackData (optional)
String The magnetic stripe/track data read from a swiped transaction. If the card reader is capable of reading both track 1 and track 2, only track 2 should be provided.
EntryMode (optional)
String The method in which card data was collected. This is used in conjunction with other properties of the transaction to determine the correct values for card and cardholder presence to send to the processor.
Manual
Swipe
ICC
Proximity
CvPresence (optional)
String The presence/status of the card verification number on the card and in the transaction
None
NotSubmitted
Submitted
Illegible
NotPresent
Street (optional)
String The billing address of the card. Used for AVS (address verification) if it is enabled for the merchant
ZipCode (optional)
String The billing zip code of the card. Used for AVS (address verification) if it is enabled for the merchant
CardDetail
Token (optional)
String The token stored as a result of the transaction.
MaskedPAN (optional)
String The transaction's masked account number.
NameOnCard (optional)
AuthorizationAmount (optional)
Double The amount of the authorization. format: double
TipAmount (optional)
Double The Amount of the tip. format: double
TotalAmount (optional)
Double The total amount of the transaction. format: double
CashBackAmount (optional)
Double The amount of cash returned on the transaction. format: double
SurchargeAmount (optional)
Double The surcharge amount. format: double
AccountType (optional)
String The type of card account.
ResultCode (optional)
String The transaction's result code.
ResultText (optional)
String The transaction's result text.
ApprovalCode (optional)
String The transaction's approval code.
HostReferenceNumber (optional)
String The transaction's processor reference number.
AvsResponse (optional)
String The transaction's AVS response.
AvsResponseText (optional)
String The transaction's AVS response message.
CvvResponse (optional)
String The transaction's CVV response.
CvvResponseText (optional)
String The transaction's CVV response message.
Level3Amount (optional)
Double The transaction's level 3 amount. format: double
CardExpiration (optional)
String The card's expiration date.
CardTokenDetail
MerchantKey (optional)
Integer The merchant key. format: int32
CustomerKey (optional)
Integer The customer key. format: int32
CardNumber (optional)
ExpirationDate (optional)
String The expiration date, formatted as MMYY.
CardType (optional)
NameOnCard (optional)
StreetAddress (optional)
String The street address for the card.
PostalCode (optional)
String The postal code for the card.
Token (optional)
String The token for the card.
CardValidationData
avsResponse (optional)
String Address verification response code
cvResponse (optional)
String Card verification response code
avsResponseText (optional)
String Text representation of the AVS response
cvResultText (optional)
String Text representation of the CVV response
streetMatchText (optional)
String Additional detail on the AVS street match
zipMatchText (optional)
String Additional detail on the AVS zip match
CashDetail
CashAmount (optional)
Double The amount of the cash transaction. format: double
CheckData
NameOnCheck
String Name of the check owner
RoutingNumber
String Uniquely identifies the bank holding funds.
AccountNumber
String Uniquely identifies the check owner’s bank account.
CheckNumber (optional)
String Uniquely identifies an individual’s check.
MICR (optional)
String Magnetic Ink Character Recognition. Note: This input is required for processing check-present and consumer-present transactions.
DriversLicense (optional)
String Check owner’s driver’s license number.
State (optional)
String Check owner’s two-character state code.
SSN (optional)
String Check owner's social security number.
DateOfBirth (optional)
String Check owner's date of birth.
CheckType (optional)
String Identifies the type of check used in the transaction.
AccountType (optional)
String Identifies the type of account used as a source of funds.
RawMICR (optional)
String Raw Magnetic Ink Check Reader data line from the check reader.
BranchCity (optional)
String City of the check owner's bank branch.
EmailAddress (optional)
String Check owner's email address.
TelephoneNumber (optional)
String Check owner's phone number.
Token (optional)
String A value generated by the gateway for payment data which has been previously stored. The format of the value depends on the format selected when the payment method was originally stored.
Address (optional)
Address Address data on the check holder.
CheckDetail
Token (optional)
String The token stored as a result of the transaction.
CheckNumber (optional)
String Uniquely identifies an individual’s check.
AccountNumber (optional)
String Uniquely identifies the check owner’s bank account.
RoutingNumber (optional)
String Uniquely identifies the bank holding funds.
DriversLicenseNumber (optional)
String Check owner’s driver’s license number.
SocialSecurityNumber (optional)
String Check owner's social security numbe.r
DateOfBirth (optional)
String Check owner's date of birth.
StateCode (optional)
String Check owner’s two-character state code.
NameOnCheck (optional)
String Name of the check owner.
EmailAddress (optional)
String Email address of the check owner.
PhoneNumber (optional)
String Phone number provided as check verification data.
CheckAmount (optional)
Double Total amount of the transaction. format: double
ResultCode (optional)
ResultText (optional)
String Description of the gateway result.
HostApproval (optional)
String Approval code or host error.
HostReferenceNumber (optional)
String Reference number provided by the processor.
ResultMessage (optional)
String Processor result message.
SecondaryResultMessage (optional)
String Additional result message detail (optional).
TertiaryResultMessage (optional)
String Additional result message detail (optional).
AccountType (optional)
String Type of account (checking/savings).
CheckType (optional)
String The type of check used for the transaction.
CheckTokenDetail
MerchantKey (optional)
Integer The merchant key. format: int32
CustomerKey (optional)
Integer The customer key. format: int32
AccountNumber (optional)
RoutingNumber (optional)
NameOnCheck (optional)
AccountType (optional)
String The account type, checking or savings.
Checking
Savings
CheckType (optional)
String The check type, personal or business.
Personal
Business
Token (optional)
String The token for this check.
Contact
LastName (optional)
String The last name, max 50 chars
FirstName (optional)
String The first name, max 50 chars
JobTitle (optional)
String The job title, max 50 chars
DepartmentName (optional)
String The department name, max 50 chars
EmailAddress (optional)
String The e-mail address, max 100 chars
DaytimeTelephoneNumber (optional)
String The daytime telephone number, max 25 chars
NighttimeTelephoneNumber (optional)
String The nighttime telephone number, max 25 chars
FaxNumber (optional)
String The fax number, max 25 chars
MobileTelephoneNumber (optional)
String The mobile telephone number, max 25 chars
ContractCustomField
Value (optional)
Key (optional)
ContractDetail
ContractKey (optional)
MerchantKey (optional)
CustomerKey (optional)
Token (optional)
BillAmount (optional)
StartDate (optional)
EndDate (optional)
MerchantContractName (optional)
MerchantContractId (optional)
BillingInterval (optional)
BillingPeriod (optional)
ActivationStatus (optional)
MaxFailures (optional)
FailureInterval (optional)
FailurePeriod (optional)
EmailMerchant (optional)
EmailCustomer (optional)
EmailMerchantFailure (optional)
EmailCustomerFailure (optional)
TaxAmount (optional)
TotalAmount (optional)
MaxAmount (optional)
CustomFields (optional)
AmountBillsToDate (optional)
EmailCustomerReceiptOption (optional)
NextBillDate (optional)
NumberPayments (optional)
NumberBillsToDate (optional)
NumberFailures (optional)
CreateTransactionRequest
TransactionType
String Identifies the type of transaction to process.
Sale
Return
Void
Force
Capture
CaptureAll
RepeatSale
Adjustment
Activate
Deactivate
Redeem
Inquire
Reload
CardData (optional)
CardData Properties of the card/account used as payment for this transaction, if the payment type is card.
CheckData (optional)
CheckData Properties of the check/checking account used as payment for this transaction, if the payment type is check.
Fsa (optional)
Fsa Optional detail amount fields used in the processing of FSA/HSA processing.
SoftDescriptor (optional)
SoftDescriptor Fields necessary to submit alternate merchant information for this transaction, when supported by the processor.
ForceDuplicate (optional)
Boolean This is an indicator that specifies - if this transaction is flagged as a duplicate of a previous transaction - whether or not this transaction will be processed.
Register (optional)
String Identifies the physical or virtual register where the transaction is run, for reporting.
InvoiceData
Invoice Tracking/reporting fields used for identifying the transaction and associating it with a customer invoice.
OriginalTransaction (optional)
OriginalTransaction Properties of the original transaction, when necessary for processing the current transaction (such as refunds, voids, reversals).
CustomFields (optional)
array[CustomField] Merchant-configured fields used to store data per transaction outside the system fields.
SignatureData (optional)
SignatureData Used to accept and store image data for receipts captured on an external device.
PurchaseCardData (optional)
PurchaseCardData Additional data as required for level 2 and level 3 processing.
AuthCode (optional)
String Original authorization/approval code, required for Force transactions.
UseInterchangeDefaults (optional)
Boolean Whether or not to provide the default values as specified for the applicable merchant in the interchange optimization configuration.
CaptureType (optional)
String Required for capture/capture all transactions. Indicates what type of payment to capture.
Credit
Debit
Check
EBT
CustomField
Name (optional)
String Name of the custom field as set by the merchant
Value (optional)
String Value (if applicable) to store in the custom field
CustomFieldResponse
Key (optional)
Integer The unique identifier of the custom field. format: int32
Name (optional)
String The name of the custom field. Cannot exceed 50 characters. Should be unique.
MerchantKey (optional)
Integer The key of the merchant that has this custom field. format: int32
IsNumeric (optional)
Boolean Indicates if the field is numeric.
DecimalPlaces (optional)
Integer Indicates the number of decimal places. format: int32
RegularExpression (optional)
String A validation expression.
IsRequired (optional)
Boolean Indicates if the field should be required input.
ActivationStatus (optional)
String Indicates the activation status of the field.
Pending
Active
Inactive
Deleted
Description (optional)
String The description of the field.
ErrorMessage (optional)
String Indicates the validation error message of the field.
MinValue (optional)
Double Indicates the minimum numeric value of the field. format: double
MaxValue (optional)
Double Indicates the maximum numeric value of the field. format: double
MaxLength (optional)
Integer Indicates the maximum character length of the field. format: int32
Position (optional)
Integer Indicates the position the field, relative to other custom fields being displayed. format: int32
DisplayOnVTReceipt (optional)
Boolean Indicates if the field is displayed on VT receipts.
DisplayOnReports (optional)
Boolean Indicates if the field is displayed on reports.
DisplayOnHpp (optional)
Boolean Indicates if the field is displayed on the HPP.
ReadOnlyOnHpp (optional)
Boolean Indicates if the field is read-only on the HPP.
VisibleOnHpp (optional)
Boolean Indicates if the field is visible on the HPP.
CustomerDetail
CustomerKey (optional)
Integer Unique identifier generated by the system for the customer format: int32
CustomerID
String Unique identifier, assigned by the merchant, as a friendly way to identify the customer
CustomerName (optional)
String Customer's full name. Can be first+last name for an individual, or the business name if applicable.
CreationTimestamp
Date The customer creation timestamp. format: date-time
LastUpdateTimestamp
Date The customer last update timestamp. format: date-time
ActivationStatus
String Indicates whether the customer is currently active or inactive. Valid values are:
1: ACTIVE – Customers contracts are reviewed each day for pending payments
2: INACTIVE – Customer is not reviewed for pending payments
MerchantKey
Integer The merchant key for the customer format: int32
SelfLink (optional)
String The link to this customer
DefaultContactLink (optional)
String The link to this customer's default contact
BillingAddressLink (optional)
String The link to this customer's billing address
ShippingAddressLink (optional)
String The link to this customer's shipping address
PaymentTokensLink (optional)
String The link to this customer's payment tokens
DeleteCardTokens
MerchantKey
Integer The key of the merchant. format: Int32
Tokens
array[String] A comma-separated list of card tokens to be deleted.
DeleteCheckTokens
MerchantKey
Integer The key of the merchant. format: Int32
Tokens
array[String] A comma-separated list of check tokens to be deleted.
DeleteContracts
MerchantKey
Integer The key of the merchant. format: Int32
CustomerKey
Integer The customer key. format: Int32
ContractKeys
Integer A comma separated list of contract keys. Limit 10. format: Int32
DeleteCustomFields
CustomFieldKeys
array[Integer] A comma-separated list of custom field keys to be deleted. format: int32
DeleteCustomers
CustomerKeys
array[Integer] A comma-separated list of customer keys to be deleted. format: int32
DeleteMerchants
MerchantKeys
array[Integer] A comma-separated list of merchant keys to be deleted. format: int32
DeleteRegisters
RegisterKeys
array[Integer] A comma-separated list of register keys to be deleted. format: int32
Dictionary<String,String>
Fsa
partialAuthSupport (optional)
Boolean Enables/disables partial authorizations for FSA transactions
qhpAmount (optional)
Float Identifies the total Healthcare amount. When additional FSA amounts are supported by a merchant, this amount includes those totals. format: float
rxAmount (optional)
Float Total amount of prescriptions used to gain access to Rxonly purses. This amount is included in the Total QHP Amount. format: float
visionAmount (optional)
Float Total amount of vision care purchases. This amount is included in Total QHP Amount. format: float
dentalAmount (optional)
Float Total amount of dental services. This amount is included in Total QHP Amount. format: float
clinicalAmount (optional)
Float Total amount of clinic or other medical services. This amount is included in Total QHP Amount. format: float
copayAmount (optional)
Float Total amount for co-payments format: float
transitAmount (optional)
Float Total amount for transit purchases; mass transit passes, for example format: float
GatewayUser
FirstName
LastName
UserName
Password
EmailAddress
ShouldChangePasswordOnNextLogin (optional)
IsTwoFactorEnabled (optional)
IsLockoutEnabled (optional)
PhoneNumber (optional)
Address1 (optional)
Address2 (optional)
City (optional)
StateCode (optional)
AK
AL
AR
AZ
CA
CO
CT
DC
DE
FL
GA
HI
IA
ID
IL
IN
KS
KY
LA
MA
MD
ME
MI
MN
MO
MS
MT
NC
ND
NE
NH
NJ
NM
NV
NY
OH
OK
OR
PA
RI
SC
SD
TN
TX
UT
VA
VT
WA
WI
WV
WY
PostalCode (optional)
CountryCode (optional)
USA
CAN
Timezone (optional)
GatewayUserResponse
Id (optional)
FirstName
LastName
UserName
Password
EmailAddress
ShouldChangePasswordOnNextLogin (optional)
IsTwoFactorEnabled (optional)
IsLockoutEnabled (optional)
PhoneNumber (optional)
Address1 (optional)
Address2 (optional)
City (optional)
StateCode (optional)
AK
AL
AR
AZ
CA
CO
CT
DC
DE
FL
GA
HI
IA
ID
IL
IN
KS
KY
LA
MA
MD
ME
MI
MN
MO
MS
MT
NC
ND
NE
NH
NJ
NM
NV
NY
OH
OK
OR
PA
RI
SC
SD
TN
TX
UT
VA
VT
WA
WI
WV
WY
PostalCode (optional)
CountryCode (optional)
USA
CAN
Timezone (optional)
GetAllCustomFields
IncludeDeleted (optional)
Boolean Whether to include deleted records in the response, defaults to false.
GetCardToken
MerchantKey
Integer The key of the merchant. format: Int32
Token
GetCardTokens
MerchantKey
Integer The key of the merchant. format: Int32
CustomerKey (optional)
Integer Constrain the records returned to those occurring on or after this value. Default is to apply no constraint. format: Int32
BeginningDate (optional)
Date Constrain the records returned to those occurring on or after this value. Default is to apply no constraint. format: date-time
EndingDate (optional)
Date Constrain the records returned to those occurring on or before this value. Default is to apply no constraint. format: date-time
SortField (optional)
String The field by which the records will be sorted. Default is 'Date'.
Date
CustomerKey
SortDirection (optional)
String The direction in which the records will be sorted. Default is 'asc'.
Asc
Desc
PageSize (optional)
Integer The number of records per page. Default is 20. format: int32
PageNumber (optional)
Integer The page number to fetch. Default is 1. format: int32
GetCheckToken
MerchantKey
Integer The key of the merchant. format: Int32
Token
GetCheckTokens
MerchantKey
Integer The key of the merchant. format: Int32
CustomerKey (optional)
Integer Constrain the records returned to those occurring on or after this value. Default is to apply no constraint. format: Int32
BeginningDate (optional)
Date Constrain the records returned to those occurring on or after this value. Default is to apply no constraint. format: date-time
EndingDate (optional)
Date Constrain the records returned to those occurring on or before this value. Default is to apply no constraint. format: date-time
SortField (optional)
String The field by which the records will be sorted. Default is 'Date'.
Date
CustomerKey
SortDirection (optional)
String The direction in which the records will be sorted. Default is 'asc'.
Asc
Desc
PageSize (optional)
Integer The number of records per page. Default is 20. format: int32
PageNumber (optional)
Integer The page number to fetch. Default is 1. format: int32
GetContracts
MerchantKey
Integer The key of the merchant. format: Int32
CustomerKey
Integer The customer key. format: Int32
ContractKeys
Integer A comma separated list of contract keys. Limit 10. format: Int32
GetCustomFields
Keys (optional)
array[Integer] A comma-separated list of custom field keys to be returned. If no keys are specified, all applicable custom fields will be returned. format: int32
GetCustomer
CustomerKey
Integer Unique identifier assigned to the customer record by the system at the time the customer record is created. format: int32
GetCustomerContracts
MerchantKey
Integer The key of the merchant. format: Int32
CustomerKey
Integer The customer key. format: Int32
GetCustomers
SortField (optional)
String The field name by which the records will be sorted. Default is 'CustomerId'.
CustomerId
CustomerName
ActivationStatus
MerchantKey
CustomerKey
IncludeDeleted (optional)
Boolean Whether to include deleted records in the response, defaults to false.
SortDirection (optional)
String The direction in which the records will be sorted. Default is 'asc'.
Asc
Desc
PageSize (optional)
Integer The number of records per page. Default is 20. format: int32
PageNumber (optional)
Integer The page number to fetch. Default is 1. format: int32
GetMerchant
MerchantKey
Integer The key of the merchant to fetch. format: Int32
GetMerchantContracts
MerchantKey
Integer The key of the merchant. format: Int32
GetMerchants
MerchantName (optional)
String Filters to a 'contains' match on the merchant name.
MerchantId (optional)
String Filters to an exact match of the merchant id.
SortField (optional)
String The field name by which the records will be sorted. Default is 'Merchant Name'.
MerchantName
MerchantId
ActivationStatus
CreationTimestamp
MerchantKey
IncludeDeleted (optional)
Boolean Whether to include deleted records in the response, defaults to false.
SortDirection (optional)
String The direction in which the records will be sorted. Default is 'asc'.
Asc
Desc
PageSize (optional)
Integer The number of records per page. Default is 20. format: int32
PageNumber (optional)
Integer The page number to fetch. Default is 1. format: int32
GetProcessorConfigurations
MerchantKey
Integer Will return all of the processor profiles for the specified merchant (unless filtered by the optional parameters.). format: int32
ProcessorName (optional)
String Will return all of the named processor profile's individual payment configurations.
PaymentConfigurationKey (optional)
Integer Will return a processor profile's specific payment configuration. format: int32
GetRegister
RegisterKey
Integer The key of the register to be returned. format: int32
GetRegisters
SortField (optional)
String The field name by which the records will be sorted. Default is 'RegisterNumber'.
RegisterNumber
RegisterName
TerminalNumber
TerminalNumber2
ActivationStatus
RegisterKey
IncludeDeleted (optional)
Boolean Whether to include deleted records in the response, defaults to false.
SortDirection (optional)
String The direction in which the records will be sorted. Default is 'asc'.
Asc
Desc
PageSize (optional)
Integer The number of records per page. Default is 20. format: int32
PageNumber (optional)
Integer The page number to fetch. Default is 1. format: int32
GetSettlementBatches
BeginDate
Date Beginning date of the settlement batch record query. format: date-time
EndDate (optional)
Date End date of the settlement batch record query. format: date-time
MerchantKey (optional)
Date The key of the merchant of the settlement batches. format: date-time
SortField (optional)
String The field name by which the records will be sorted. Default is 'BatchDate'.
BatchDate
BatchId
TotalAmount
SortDirection (optional)
String The direction in which the records will be sorted. Default is 'asc'.
Asc
Desc
PageSize (optional)
Integer The number of records per page. Default is 20. format: int32
PageNumber (optional)
Integer The page number to fetch. Default is 1. format: int32
GetSettlementDetail
BatchId
SortField (optional)
String The field name by which the records will be sorted. Default is 'BeginDate'.
PnRef
InvoiceNumber
TransactionTimestamp
AuthorizationTimestamp
MerchantKey
ResellerKey
PaymentType
TransactionType
Processor
SortDirection (optional)
String The direction in which the records will be sorted. Default is 'asc'.
Asc
Desc
PageSize (optional)
Integer The number of records per page. Default is 20. format: int32
PageNumber (optional)
Integer The page number to fetch. Default is 1. format: int32
GetTransaction
PnRefs
array[Integer] A comma separated list of transaction reference numbers. Limit 10. format: int32
GetTransactions
BeginDate
Date Beginning date of the transaction record query. format: date-time
EndDate (optional)
Date End date of the transaction record query. format: date-time
TransactionTypes (optional)
array[String] If provided, only those transactions matching the TransactionTypes will be included.
InvoiceNumber (optional)
String The invoice ID that was included in the original transaction. If provided, only those transactions with matching invoiceId will be included.
SettlementFlag (optional)
String The SettlementFlag parameter allows you to choose whether settled or unsettled transactions are included in the results.
All
Unsettled
Settled
SettleBeginDate (optional)
Date Beginning date of the settlement search window. format: date-time
SettleEndDate (optional)
Date End date of the settlement search window. format: date-time
SettleMessage (optional)
String The settlement ID or message returned from the host.
SettleStatus (optional)
String Allows you to choose whether settled or unsettled transactions are included in the results.
Username (optional)
String The user who originated the transactions. If provided, only those transactions created by the matching User will be included.
ResultCodes (optional)
array[String] If provided, only those transactions matching the Result will be included.
Register (optional)
String The register (if applicable) on which the transaction was processed
ApprovalCode (optional)
String The approval code is a alphanumeric value generated by the issuing bank. This field may also be used by payment processors to return error messages.
Note: Approval codes are not necessarily unique and there is potential (rare) for more than one record to be returned.
NameOnInstrument (optional)
String For card transactions, this is the name on the card. For check transactions, this is the name on the check. If provided, only those transactions with a matching instrument name will be included.
CustomerId (optional)
String Merchant-assigned identifier of the customer associated with the transaction(s)
ContractId (optional)
String Merchant-assigned identifier of the contract associated with the transaction(s)
ContractKey (optional)
Integer System-assigned identifier of the contract associated with the transaction(s) format: int32
SortField (optional)
String The field name by which the records will be sorted. Default is 'BeginDate'.
PnRef
InvoiceNumber
TransactionTimestamp
AuthorizationTimestamp
MerchantKey
ResellerKey
PaymentType
TransactionType
Processor
TotalAmountMax (optional)
Double Specifies the maximum amount value of the transactions being searched for. In DDDDDD.CC format format: double
TotalAmountMin (optional)
Double Specifies the minimum amount value of the transactions being searched for. In DDDDDD.CC format format: double
PaymentTypes (optional)
array[String] If provided, only those transactions matching the Payment Type will be included.
CardNumber (optional)
String If provided, only those transactions with an exact Card Number match will be included.
CheckTypes (optional)
array[String] If provided, only those transactions matching the Check Type will be included.
CheckAccountTypes (optional)
array[String] If provided, only those transactions matching the Check Account Type will be included.
CheckAccountNumber (optional)
Integer If provided, only those transactions with an exact Check Account Number match will be included. format: int32
CheckRoutingNumber (optional)
Integer If provided, only those transactions with an exact Check Routing Number match will be included. format: int32
SortDirection (optional)
String The direction in which the records will be sorted. Default is 'asc'.
Asc
Desc
PageSize (optional)
Integer The number of records per page. Default is 20. format: int32
PageNumber (optional)
Integer The page number to fetch. Default is 1. format: int32
Invoice
customerId (optional)
String Unique identifier for the customer/cardholder
totalAmount
Float Total amount of the transaction format: float
tipAmount (optional)
Float Amount charged at the cardholder's discretion for tip/gratuity format: float
taxAmount (optional)
Float Amount charged by a merchant for state/local sales tax format: float
shippingAmount (optional)
Float Amount charged by a merchant for shipping physical goods format: float
convenienceAmount (optional)
Float Allows the merchant to add a flat fee to the total transaction. This function may be used by utility companies, government agencies, and schools. format: float
surchargeAmount (optional)
Float Amount charged by a merchant in exchange for processing a specific transaction format: float
cashbackAmount (optional)
Float Amount requested by the card holder in cash back for an eligible transaction format: float
KeyValuePair<String,String>
Key (optional)
Value (optional)
MerchantAccessSettings
BinManagementApi (optional)
DialIn (optional)
Internet (optional)
MerchantCardVerificationSettings
AVAddNotVerifiable (optional)
AVInvalidAddZip (optional)
AVZipOnly (optional)
AVNoMatch (optional)
AVIssuerUnavail (optional)
AVVerUnavail (optional)
AVAddOnly (optional)
AVNotRequested (optional)
AVUnregCode (optional)
AVServUnsupported (optional)
AVExactMatch (optional)
AVNoData (optional)
AVAddNotVerifiableGlobal (optional)
CVNotPresent (optional)
CVNoData (optional)
CVNotProcessed (optional)
CVNoDataFromIssuer (optional)
CVMatch (optional)
CVUnregCode (optional)
CVNoMatch (optional)
MerchantConfigurations
SecuritySettings (optional)
AccessSettings (optional)
MerchantVirtualTerminalSettings (optional)
MerchantDetail
MerchantKey (optional)
Integer Unique (system-generated) identifier. format: int32
ResellerKey (optional)
Integer Parent reseller containing the merchant. format: int32
DefaultUserKey (optional)
Integer The default user for the merchant. format: int32
PrimaryContactKey (optional)
Integer The primary contact for the merchant. format: int32
MerchantName (optional)
String The name of the merchant.
MerchantId (optional)
String Identifier (user-supplied) for the merchant.
AlternateMerchantId (optional)
String Alternate identifier (user-supplied) for the merchant.
AutoCloseBatch (optional)
Boolean Enable/disable auto-closing of the merchant's batch (for terminal capture processor configurations).
AutoCloseBatchHour (optional)
Date Hour for auto-close to occur, if enabled. format: date-time
ForceDuplicate (optional)
Boolean If enabled, the gateway will block transactions that appear to duplicate an existing transaction within the same day, and will require a ForceDuplicate flag to override.
RequirePNRef (optional)
Boolean If enabled, the merchant must supply a valid PNRef of an original sale to process a refund, and the refund may not be greater than the amount of the original sale. Disabling this option allows 'unlinked returns'.
IsTestMerchant (optional)
Boolean When enabled, transactions are directed to the processors' test hosts for development and testing purposes.
ActivationStatus (optional)
String The activation status of the merchant.
Pending
Active
Inactive
Deleted
EnableFraud (optional)
Boolean Indicated if fraud detection is on or off.
EnableOfflineBatch (optional)
Boolean Indicates if offline batched are on or off.
AllowHostedPage (optional)
Boolean Indicates is the merchant should have access to the hosted payments page.
AllowEmulator (optional)
Boolean Indicates if use of the emulator is allowed.
LimitToDebit (optional)
CollectLevel3 (optional)
CreationTimestamp (optional)
Date The timestamp of the merchant record's creation. format: date-time
MerchantConfigurations (optional)
SelfLink (optional)
String A self reference to the merchant.
ResellerLink (optional)
String A reference to the reseller of the merchant.
DefaultUserLink (optional)
String A reference to the default user of the merchant.
PrimaryContactLink (optional)
String A reference to the primary contact of the merchant.
ProcessorProfilesLink (optional)
String A reference to the processor profiles of the merchant.
BusinessInformationLink (optional)
String A reference to the business information of the merchant.
AddressInformationLink (optional)
String A reference to the address information of the merchant.
MerchantDetailResults
Merchants (optional)
Pagination (optional)
MerchantSecuritySettings
SaleLevel (optional)
CreditLevel (optional)
VoidLevel (optional)
PreAuthLevel (optional)
ForceAuthLevel (optional)
AdjustLevel (optional)
ActivateLevel (optional)
DeactivateLevel (optional)
InquireLevel (optional)
RedeemLevel (optional)
ReloadLevel (optional)
RefundLevel (optional)
ToolsLevel (optional)
ReportsLevel (optional)
CurrentBatchLevel (optional)
BatchesLevel (optional)
AdminLevel (optional)
ChangeSecurityLevel (optional)
SettleLevel (optional)
RecurringBillingLevel (optional)
PreferenceLevel (optional)
FraudLevel (optional)
MerchantVirtualTerminalSettings
VirtualTerminalCreditAccess (optional)
VirtualTerminalLevel3Amount (optional)
VirtualTerminalConvenienceAmount (optional)
VirtualTerminalDutyAmount (optional)
VirtualTerminalTaxAmount (optional)
VirtualTerminalTipAmount (optional)
ImageCapture (optional)
ReceiptCapture (optional)
AutoSettleMerchantEmail (optional)
InvoiceDuplicate (optional)
VirtualTerminalCommercialCard (optional)
VirtualTerminalShippingAmount (optional)
VirtualTerminalAllowRepeat (optional)
RequireInvoice (optional)
RequireNameOnCard (optional)
RequireLevelII (optional)
VirtualTerminalRecurringBilling (optional)
VirtualTerminalEmailReceipts (optional)
VirtualTerminalPrintTwoReceipts (optional)
VirtualTerminalInvNum (optional)
VirtualTerminalPONum (optional)
VirtualTerminalCustomerID (optional)
VirtualTerminalCustomer (optional)
VirtualTerminalStreet (optional)
VirtualTerminalCity (optional)
VirtualTerminalState (optional)
VirtualTerminalZip (optional)
VirtualTerminalPhone (optional)
VirtualTerminalEmail (optional)
VirtualTerminalAutoTaxAmount (optional)
VirtualTerminalAutoCalcTax (optional)
EnableFraud (optional)
EnableOfflineBatch (optional)
EnableHostedPage (optional)
EnableEmulator (optional)
LimitToDebit (optional)
CollectLevel3 (optional)
AuthEdit (optional)
ApplyLevel2DefaultsToApi (optional)
RequireShipping (optional)
RequireZipCode (optional)
EnableGsaBinCheck (optional)
ResellerOnlyCustomFieldsMenu (optional)
ResellerOnlyHostedPaymentPageMenu (optional)
ResellerOnlyOrderDataDefaultsMenu (optional)
ResellerOnlyEmulatorMenu (optional)
ResellerOnlyFraudControlSettingsMenu (optional)
ResellerOnlyFraudControlHeldLogMenus (optional)
CardVerification (optional)
OriginalTransaction
pnRef (optional)
Integer Unique payment reference number used to identify a single transaction within the system. The payment reference number (PNRef) is assigned by the payment server at the time the transaction is created. format: int32
authCode (optional)
String Original authorization/approval code
PaginationStats
CurrentPageNumber (optional)
PageSize (optional)
TotalRecordCount (optional)
PatchCardToken
MerchantKey
Integer The key of the merchant. format: Int32
Token
CardNumber (optional)
ExpirationDate (optional)
String The expiration date, formatted as MMYY.
NameOnCard (optional)
StreetAddress (optional)
String The street address for the card.
PostalCode (optional)
String The postal code for the card.
PatchCheckToken
MerchantKey
Integer The key of the merchant. format: Int32
Token
AccountNumber (optional)
RoutingNumber (optional)
NameOnCheck (optional)
AccountType (optional)
String The account type, checking or savings.
Checking
Savings
CheckType (optional)
String The check type, personal or business.
Personal
Business
PatchContract
MerchantKey
Integer The key of the merchant. format: Int32
CustomerKey
Integer The customer key. format: Int32
ContractKey
Integer The key of the contract to patch. format: Int32
Token (optional)
String The token representing customer payment data.
BillAmount (optional)
Double Amount billed each time the contract comes due in DD.CC format. format: double
StartDate (optional)
Date Date that the contract becomes effective in YYYY/MM/DD format. The start date must be greater than today’s date.
The StartDate represents the first time the customer will be billed per the contract. Future bill dates are calculated using the BillingPeriod and BillingInterval parameters. format: date-time
EndDate (optional)
Date Date that the contract is completed in YYYY/MM/DD format. The end date must be greater than the start date. format: date-time
MerchantContractName (optional)
String Merchant defined friendly name for this contract
MerchantContractId (optional)
String Merchant defined identification for this contract. This is not a unique identifier within the gateway but rather a way for the merchant to identify a contract.
BillingPeriod (optional)
String This value is used in conjunction with the BillingInterval to compute the next bill date for a contract. The system will automatically account for 31 day months and/or leap years. For example: Recurring billing is set to run once monthly. The contract start date is set for the 31st. If the next month only has 30 days, recurring billing will automatically run the transaction on the 30th.
Week
Month
Year
ActivationStatus (optional)
String Indicates whether the contract is currently active (reviewed each day for pending payments due) or inactive
Active
Inactive
Deleted
MaxFailures (optional)
Integer The number of times the system will try to re-process a failed payment before the contract is placed in suspended state. If left blank, the default value is zero (0). A MaxFailure = 0 means that the system will not try to reprocess a failed payment.
IMPORTANT: When a payment fails to process and the MaxFailures parameter is set to a value greater than zero (0), all future payments will be ignored until the failed payment is either successfully processed or the contract is suspended. format: int32
BillingInterval (optional)
Integer This value is used in conjunction with the BillingPeriod to compute the next bill date for a contract. format: int32
2
4
14
21
28
FailureInterval (optional)
Integer The interval in days between attempts to retry processing a failed payment. format: int32
FailurePeriod (optional)
String Sets the FailureInterval time period.
Week
EmailCustomerReceiptOption (optional)
String Determines under what circumstances a receipt will be emailed to the customer.
OnApproval
OnDecline
All
EmailMerchant (optional)
Boolean Indicates whether the system will send an email to the merchant after successfully processing a scheduled payment.
EmailCustomer (optional)
Boolean Indicates whether the system will send an email to the customer after successfully processing a scheduled payment.
EmailMerchantFailure (optional)
Boolean Indicates whether the system will send an email to the merchant after failing to process a scheduled payment.
EmailCustomerFailure (optional)
Boolean Indicates whether the system will send an email to the customer after failing to process a scheduled payment.
TaxAmount (optional)
Double Tax amount applied to the BillAmount in DD.CC format. format: double
TotalAmount (optional)
Double Total amount billed, including tax, each time the contract comes due in DD.CC format. format: double
MaxAmount (optional)
Double Maximum amount allowed for the full term of this contract in DD.CC format. format: double
CustomFields (optional)
array[ContractCustomField] A collection of custom field objects. The complete set of custom fields will be replaced on a patch. For example, if a contract currently has two custom fields and a patch request contains just one custom field, the updated contract will contain only one custom field - the one passed in on the patch request.
PatchCustomField
Key
Integer The key of the custom field to be edited. format: int32
Name (optional)
String The name of the custom field. Cannot exceed 50 characters. Should be unique.
IsNumeric (optional)
Boolean Indicates the IsNumeric value for the field.
DecimalPlaces (optional)
Integer Indicates the number of decimal places for the field (used with numeric fields). format: int32
RegularExpression (optional)
String Indicates the regular expression value for the field.
IsRequired (optional)
Boolean Indicates if the field is required.
ActivationStatus (optional)
String Indicates the initial activation status value for the field.
Pending
Active
Inactive
Deleted
Description (optional)
String Indicates the description value for the field. Cannot exceed 50 characters.
ErrorMessage (optional)
String Indicates the error message value for the field. Cannot exceed 50 characters.
MinValue (optional)
Double Indicates the minimum numeric value for the field (used with numeric fields). format: double
MaxValue (optional)
Double Indicates the minimum numeric value for the field (used with numeric fields). format: double
MaxLength (optional)
Integer Indicates the maximum text length value for the field (used with non-numeric fields). format: int32
Position (optional)
Integer Indicates the position value for the field. format: int32
DisplayOnVTReceipt (optional)
Boolean Indicates if the field should be displayed on virtual terminal receipt.
DisplayOnReports (optional)
Boolean Indicates if the field should be displayed on reports.
DisplayOnHpp (optional)
Boolean Indicates if the field should be displayed on the hosted payments page.
ReadOnlyOnHpp (optional)
Boolean Indicates if the field should not be editable on the hosted payments page.
VisibleOnHpp (optional)
Boolean Indicates if the field should be visible on the hosted payments page.
PatchCustomer
CustomerKey
Integer The key of the customer to be edited. format: int32
CustomerName (optional)
String The name of the customer. Cannot exceed 100 characters.
CustomerId (optional)
String The ID of the customer. Cannot exceed 50 characters.
ActivationStatus (optional)
Pending
Active
Inactive
Deleted
Status (optional)
PatchMerchant
MerchantKey
Integer The merchant key. format: int32
ResellerKey (optional)
Integer The reseller key. format: int32
MerchantName (optional)
MerchantId (optional)
AlternateMerchantId (optional)
String The alternate merchant ID.
AutoCloseBatch (optional)
Boolean Whether to auto-close batches.
AutoCloseBatchTimestamp (optional)
Date When to auto-close batches. format: date-time
ForceDuplicate (optional)
Boolean Whether to force duplicates.
RequirePNRef (optional)
IsTestMerchant (optional)
Boolean Whether this is a test merchant.
EnableFraud (optional)
EnableOfflineBatch (optional)
Boolean Whether to enable offline batching.
AllowHostedPage (optional)
Boolean Whether to allow hosted page.
AllowEmulator (optional)
LimitToDebit (optional)
CollectLevel3 (optional)
Boolean Whether to collect level 3.
ActivationStatus (optional)
Pending
Active
Inactive
Deleted
PatchRegister
RegisterKey
Integer The key of the custom field to be edited. format: int32
ActivationStatus (optional)
Pending
Active
Inactive
Deleted
Status (optional)
RegisterName (optional)
TerminalNumber (optional)
TerminalNumber2 (optional)
String The second terminal number.
ProcessorId
PaymentConfiguration
PaymentMethodKey (optional)
Integer The unique identifier for this profile. format: int32
PaymentType (optional)
String The payment type this configuration supports (i.e. 'EBT', 'VISA', etc.).
IsHostBased (optional)
Boolean Indicates if the processing profile supports host-based settlement.
IsHostBasedManualSettle (optional)
Boolean Indicates if the processing profile supports host-based manual settlement.
Settings (optional)
PnRefTokenDetail
CardToken (optional)
CheckToken (optional)
PostCardToken
MerchantKey
Integer The key of the merchant. format: Int32
CustomerKey (optional)
Integer The customer key. format: Int32
CardNumber
ExpirationDate
String The expiration date, formatted as MMYY.
NameOnCard (optional)
StreetAddress (optional)
String The street address for the card.
PostalCode (optional)
String The postal code for the card.
TokenFormat (optional)
String The token format for this card
Uid
CardFormat
Integer
PostCheckToken
MerchantKey
Integer The key of the merchant. format: Int32
CustomerKey (optional)
Integer The key of the customer. format: Int32
AccountNumber
RoutingNumber
NameOnCheck
AccountType (optional)
String The account type, checking or savings. Default is checking.
Checking
Savings
CheckType (optional)
String The check type, personal or business. Default is personal
Personal
Business
TokenFormat (optional)
String The token format for this card
Uid
Integer
PostContract
MerchantKey
Integer The key of the merchant. format: Int32
CustomerKey
Integer The customer key. format: Int32
Token
String The token representing customer payment data.
BillAmount
Double Amount billed each time the contract comes due in DD.CC format. format: double
StartDate
Date Date that the contract becomes effective in YYYY/MM/DD format. The start date must be greater than today’s date.
The StartDate represents the first time the customer will be billed per the contract. Future bill dates are calculated using the BillingPeriod and BillingInterval parameters. format: date-time
EndDate (optional)
Date Default is 3000/01/01 - equivalent to no end date. Date that the contract is completed in YYYY/MM/DD format. The end date must be greater than the start date. format: date-time
MerchantContractName (optional)
String Default is None. Merchant defined friendly name for this contract
MerchantContractId (optional)
String Default is None. Merchant defined identification for this contract. This is not a unique identifier within the gateway but rather a way for the merchant to identify a contract.
MaxFailures (optional)
Integer Default is 10. The number of times the system will try to re-process a failed payment before the contract is placed in suspended state. If left blank, the default value is zero (0). A MaxFailure = 0 means that the system will not try to reprocess a failed payment.
IMPORTANT: When a payment fails to process and the MaxFailures parameter is set to a value greater than zero (0), all future payments will be ignored until the failed payment is either successfully processed or the contract is suspended. format: int32
BillingInterval (optional)
Integer Default is 1. This value is used in conjunction with the BillingPeriod to compute the next bill date for a contract. format: int32
2
4
14
21
28
FailureInterval (optional)
Integer Default is 1. The interval in days between attempts to retry processing a failed payment. format: int32
EmailMerchant (optional)
Boolean Default is false. Indicates whether the system will send an email to the merchant after successfully processing a scheduled payment.
EmailCustomer (optional)
Boolean Default is false. Indicates whether the system will send an email to the customer after successfully processing a scheduled payment.
EmailMerchantFailure (optional)
Boolean Default is false. Indicates whether the system will send an email to the merchant after failing to process a scheduled payment.
EmailCustomerFailure (optional)
Boolean Default is false. Indicates whether the system will send an email to the customer after failing to process a scheduled payment.
TaxAmount (optional)
Double Default is 0.00. Tax amount applied to the BillAmount in DD.CC format. format: double
TotalAmount (optional)
Double Default is 0.00. Total amount billed, including tax, each time the contract comes due in DD.CC format. format: double
MaxAmount (optional)
Double Default is 0.00. Maximum amount allowed for the full term of this contract in DD.CC format. format: double
CustomFields (optional)
BillingPeriod (optional)
String Default is Month. This value is used in conjunction with the BillingInterval to compute the next bill date for a contract. The system will automatically account for 31 day months and/or leap years. For example: Recurring billing is set to run once monthly. The contract start date is set for the 31st. If the next month only has 30 days, recurring billing will automatically run the transaction on the 30th.
WEEK
MONTH
YEAR
ActivationStatus (optional)
String Default is Active. Indicates whether the contract is currently active (reviewed each day for pending payments due) or inactive
Active
Inactive
Deleted
FailurePeriod (optional)
String Default is Day. Sets the FailureInterval time period.
WEEK
EmailCustomerReceiptOption (optional)
String Default is Never. Determines under what circumstances a receipt will be emailed to the customer.
OnApproval
OnDecline
All
PostCustomField
Name
String The name of the custom field. Cannot exceed 50 characters. Should be unique.
IsNumeric
Boolean Indicates the IsNumeric value for the field.
ActivationStatus
String Indicates the initial activation status value for the field.
Pending
Active
DecimalPlaces (optional)
Integer Indicates the number of decimal places for the field (used with numeric fields). format: int32
RegularExpression (optional)
String Indicates the regular expression value for the field.
IsRequired (optional)
Boolean Indicates if the field is required.
Description (optional)
String Indicates the description value for the field. Cannot exceed 50 characters.
ErrorMessage (optional)
String Indicates the error message value for the field. Cannot exceed 50 characters.
MinValue (optional)
Double Indicates the minimum numeric value for the field (used with numeric fields). format: double
MaxValue (optional)
Double Indicates the minimum numeric value for the field (used with numeric fields). format: double
MaxLength (optional)
Integer Indicates the maximum text length value for the field (used with non-numeric fields). format: int32
Position (optional)
Integer Indicates the position value for the field. format: int32
DisplayOnVTReceipt (optional)
Boolean Indicates if the field should be displayed on virtual terminal receipt.
DisplayOnReports (optional)
Boolean Indicates if the field should be displayed on reports.
DisplayOnHpp (optional)
Boolean Indicates if the field should be displayed on the hosted payments page.
ReadOnlyOnHpp (optional)
Boolean Indicates if the field should not be editable on the hosted payments page.
VisibleOnHpp (optional)
Boolean Indicates if the field should be visible on the hosted payments page.
PostCustomer
CustomerName
String The name of the customer. Cannot exceed 100 characters.
CustomerId (optional)
String The ID of the customer. Cannot exceed 50 characters.
MerchantKey (optional)
Integer The merchant key for the customer. Only required for a reseller. format: int32
DefaultContact
Contact The default contact for the customer.
ShippingAddress (optional)
Address The shipping address for the customer. Either a shipping address, a billing address, or both are required.
BillingAddress (optional)
Address The billing address for the customer. Either a shipping address, a billing address, or both are required.
ActivationStatus
Pending
Active
PostMerchant
ResellerKey (optional)
Integer The reseller key, if supplied must the in the reseller's hierarchy. format: int32
MerchantName (optional)
MerchantId (optional)
AlternateMerchantId (optional)
String The alternate merchant ID.
AutoCloseBatch (optional)
Boolean Whether to auto-close batches, default is true.
AutoCloseBatchTimestamp (optional)
Date When to auto-close batches, default is 10:00 PM. format: date-time
ForceDuplicate (optional)
Boolean Whether to force duplicates, default is true.
RequirePNRef (optional)
IsTestMerchant (optional)
Boolean Whether this is a test merchant, default is false.
ActivationStatus
Pending
Active
EnableFraud (optional)
EnableOfflineBatch (optional)
Boolean Whether to enable offline batching.
AllowHostedPage (optional)
Boolean Whether to allow hosted page, default is true.
AllowEmulator (optional)
Boolean Whether to allow emulator, default is true.
LimitToDebit (optional)
CollectLevel3 (optional)
Boolean Whether to collect level 3.
PrimaryContact (optional)
Contact The primary contact for the merchant.
Address (optional)
Address The address for the merchant. Allowed only if primary contact is supplied.
BusinessInformation (optional)
DefaultUser (optional)
PostMerchantGatewayUser
MerchantKey
FirstName
LastName
UserName
Password
EmailAddress
ShouldChangePasswordOnNextLogin (optional)
IsTwoFactorEnabled (optional)
IsLockoutEnabled (optional)
PhoneNumber (optional)
Address1 (optional)
Address2 (optional)
City (optional)
StateCode (optional)
AK
AL
AR
AZ
CA
CO
CT
DC
DE
FL
GA
HI
IA
ID
IL
IN
KS
KY
LA
MA
MD
ME
MI
MN
MO
MS
MT
NC
ND
NE
NH
NJ
NM
NV
NY
OH
OK
OR
PA
RI
SC
SD
TN
TX
UT
VA
VT
WA
WI
WV
WY
PostalCode (optional)
CountryCode (optional)
USA
CAN
Timezone (optional)
PostPnRefToken
MerchantKey
Integer The key of the merchant. format: Int32
CustomerKey (optional)
Integer The customer key. format: Int32
PnRef
Integer The PnRef to create a token from. format: Int32
TokenFormat (optional)
String The token format for this card
Uid
Integer
PostQuickPaymentsKeyRequest
MerchantKey
Integer Indicates the merchant key for the QuickPayments Key. format: int32
PostQuickPaymentsTokenRequest
QuickPaymentsKey
CardData (optional)
CardData Contains card payment data for the QuickPayments Token.
CheckData (optional)
CheckData Contains check payment data for the QuickPayments Token.
PostRegister
RegisterNumber
ActivationStatus
Pending
Active
RegisterName (optional)
TerminalNumber (optional)
TerminalNumber2 (optional)
String The second terminal number.
ProcessorId
PostTokenRequest
QuickPaymentsKey
QuickPaymentsToken
String The QuickPayments Token.
TokenFormat (optional)
String The format of the requested token.
Uid
Integer
ProcessorConfiguration
ProcessorName (optional)
String The name of the payment processor for this this profile.
MerchantKey (optional)
Integer The merchant that owns the processor profiles listed. format: int32
PaymentConfigurations (optional)
PurchaseCardData
PurchaseOrderNumber (optional)
String A merchant-assigned number to identify the customer or the purchase order.
MerchantPostalCode (optional)
String The postal code of the merchant's location.
IsTaxExempt (optional)
Boolean Indicates if the transaction is tax exempt.
InvoiceNumber (optional)
String The invoice number assigned by the merchant.
ShipFromPostalCode (optional)
String The source postal code of goods that are shipped.
DestinationPostalCode (optional)
String The destination/delivery postal code for goods that are shipped.
DestinationState (optional)
String The destination/delivery two-character state code for goods that are shipped. Examples: Colorado is 'CO', New York is 'NY'.
DestinationCountryCode (optional)
Integer The destination/delivery ISO 3166-1 numeric country code for goods that are shipped. Examples: The USA is 840, Cananda is 124. format: int32
OrderNumber (optional)
String The order number assigned by the merchant.
TotalFreightAmount (optional)
Double The freight total for the transaction. format: double
TotalSalesTaxAmount (optional)
Double The sales tax total for the transaction. format: double
TotalDutyAmount (optional)
Double The duty total for the transaction. format: double
TotalDiscountAmount (optional)
Double The discount total for the transaction. format: double
MerchantTaxId (optional)
String The merchant's tax identification number.
TransactionDate (optional)
Date The date the transaction occurs. May be today's date, or a past/future date depending on the type of transaction and goods delivered. Defaults to the current date. format: date-time
PurchaseCardLineItemData (optional)
PurchaseCardLineItemData
UniversalProductCode (optional)
String The Universal Product Code of theline item.
CommodityCode (optional)
String Identifies the line item for international commerce.
ProductDescription (optional)
String The description of the product.
ItemCode (optional)
String Additional code for the line item.
ItemDescription (optional)
String Additional description for the line item.
InvoiceNumber (optional)
String The invoice number assigned by the merchant.
Quantity (optional)
Float The unit quantity for this line item. format: float
QuantityExponent (optional)
Integer The unit quantity exponent (MasterCard) for this line item. format: int32
UnitOfMeasure (optional)
String The unit of measure for this line item.
UnitPrice (optional)
Double The unit price for this line item. format: double
UnitPriceExponent (optional)
Integer The unit price exponent (MasterCard) for this line item. format: int32
DiscountAmount (optional)
Double The discounted amount for this line item. format: double
TotalAmount (optional)
Double The total amount for this line item (all taxes, fees and discounts included). format: double
TaxAmount (optional)
Double The unit tax amount for this line item. format: double
TaxAmountExponent (optional)
Integer The unit tax amount exponent (MasterCard) for this line item. format: int32
TaxRate (optional)
Double The tax rate for this line item. format: double
TaxIndicator (optional)
String Indicates the type of tax applied to this line item.
Local
State
National
TaxType (optional)
String Indicates the tax type applied to this line item.
US
Canadian
ExtendedAmount (optional)
String Indicates unit price multiplied by the quantity.
FreightAmount (optional)
Double The freight amount for this line item. format: double
DutyAmount (optional)
Double The duty amount for this line item. format: double
IsTaxIncluded (optional)
Boolean Indicates if tax is included in the line item total.
DebitCreditIndicator (optional)
String Indicates if the transactionis debit or credit.
C
D
IsTaxExempt (optional)
Boolean Indicates if the line is tax exempt.
PutCardToken
MerchantKey
Integer The key of the merchant. format: Int32
Token
CardNumber
ExpirationDate
String The expiration date, formatted as MMYY.
NameOnCard (optional)
StreetAddress (optional)
String The street address for the card.
PostalCode (optional)
String The postal code for the card.
PutCheckToken
MerchantKey
Integer The key of the merchant. format: Int32
Token
AccountNumber
RoutingNumber
NameOnCheck (optional)
AccountType (optional)
String The account type, checking or savings. Default is checking.
Checking
Savings
CheckType (optional)
String The check type, personal or business. Default is personal.
Personal
Business
PutContract
ContractKey
Integer The key of the contract to replace. format: Int32
MerchantKey
Integer The key of the merchant. format: Int32
CustomerKey
Integer The customer key. format: Int32
Token
String The token representing customer payment data.
BillAmount
Double Amount billed each time the contract comes due in DD.CC format. format: double
StartDate
Date Date that the contract becomes effective in YYYY/MM/DD format. The start date must be greater than today’s date.
The StartDate represents the first time the customer will be billed per the contract. Future bill dates are calculated using the BillingPeriod and BillingInterval parameters. format: date-time
EndDate (optional)
Date Default is 3000/01/01 - equivalent to no end date. Date that the contract is completed in YYYY/MM/DD format. The end date must be greater than the start date. format: date-time
MerchantContractName (optional)
String Default is None. Merchant defined friendly name for this contract
MerchantContractId (optional)
String Default is None. Merchant defined identification for this contract. This is not a unique identifier within the gateway but rather a way for the merchant to identify a contract.
MaxFailures (optional)
Integer Default is 10. The number of times the system will try to re-process a failed payment before the contract is placed in suspended state. If left blank, the default value is zero (0). A MaxFailure = 0 means that the system will not try to reprocess a failed payment.
IMPORTANT: When a payment fails to process and the MaxFailures parameter is set to a value greater than zero (0), all future payments will be ignored until the failed payment is either successfully processed or the contract is suspended. format: int32
BillingInterval (optional)
Integer Default is 1. This value is used in conjunction with the BillingPeriod to compute the next bill date for a contract. format: int32
2
4
14
21
28
FailureInterval (optional)
Integer Default is 1. The interval in days between attempts to retry processing a failed payment. format: int32
EmailMerchant (optional)
Boolean Default is false. Indicates whether the system will send an email to the merchant after successfully processing a scheduled payment.
EmailCustomer (optional)
Boolean Default is false. Indicates whether the system will send an email to the customer after successfully processing a scheduled payment.
EmailMerchantFailure (optional)
Boolean Default is false. Indicates whether the system will send an email to the merchant after failing to process a scheduled payment.
EmailCustomerFailure (optional)
Boolean Default is false. Indicates whether the system will send an email to the customer after failing to process a scheduled payment.
TaxAmount (optional)
Double Default is 0.00. Tax amount applied to the BillAmount in DD.CC format. format: double
TotalAmount (optional)
Double Default is 0.00. Total amount billed, including tax, each time the contract comes due in DD.CC format. format: double
MaxAmount (optional)
Double Default is 0.00. Maximum amount allowed for the full term of this contract in DD.CC format. format: double
CustomFields (optional)
BillingPeriod (optional)
String Default is Month. This value is used in conjunction with the BillingInterval to compute the next bill date for a contract. The system will automatically account for 31 day months and/or leap years. For example: Recurring billing is set to run once monthly. The contract start date is set for the 31st. If the next month only has 30 days, recurring billing will automatically run the transaction on the 30th.
WEEK
MONTH
YEAR
ActivationStatus (optional)
String Default is Active. Indicates whether the contract is currently active (reviewed each day for pending payments due) or inactive
Active
Inactive
Deleted
FailurePeriod (optional)
String Default is Day. Sets the FailureInterval time period.
WEEK
EmailCustomerReceiptOption (optional)
String Default is Never. Determines under what circumstances a receipt will be emailed to the customer.
OnApproval
OnDecline
All
PutCustomField
Key
Integer The key of the custom field to be edited. format: int32
Name
String The name of the custom field. Cannot exceed 50 characters. Should be unique.
IsNumeric
Boolean Indicates the IsNumeric value for the field.
DecimalPlaces (optional)
Integer Indicates the number of decimal places for the field (used with numeric fields). format: int32
RegularExpression (optional)
String Indicates the regular expression value for the field.
IsRequired (optional)
Boolean Indicates if the field is required.
ActivationStatus (optional)
String Indicates the initial activation status value for the field.
Pending
Active
Inactive
Deleted
Description (optional)
String Indicates the description value for the field. Cannot exceed 50 characters.
ErrorMessage (optional)
String Indicates the error message value for the field. Cannot exceed 50 characters.
MinValue (optional)
Double Indicates the minimum numeric value for the field (used with numeric fields). format: double
MaxValue (optional)
Double Indicates the minimum numeric value for the field (used with numeric fields). format: double
MaxLength (optional)
Integer Indicates the maximum text length value for the field (used with non-numeric fields). format: int32
Position (optional)
Integer Indicates the position value for the field. format: int32
DisplayOnVTReceipt (optional)
Boolean Indicates if the field should be displayed on virtual terminal receipt.
DisplayOnReports (optional)
Boolean Indicates if the field should be displayed on reports.
DisplayOnHpp (optional)
Boolean Indicates if the field should be displayed on the hosted payments page.
ReadOnlyOnHpp (optional)
Boolean Indicates if the field should not be editable on the hosted payments page.
VisibleOnHpp (optional)
Boolean Indicates if the field should be visible on the hosted payments page.
PutCustomer
CustomerKey
Integer The key of the customer to be edited. format: int32
CustomerName
String The name of the customer. Cannot exceed 100 characters.
CustomerId (optional)
String The ID of the customer. Cannot exceed 50 characters.
ActivationStatus
Pending
Active
Inactive
Deleted
PutMerchant
MerchantKey
Integer The merchant key. format: int32
ResellerKey
Integer The reseller key. format: int32
MerchantName (optional)
MerchantId (optional)
AlternateMerchantId (optional)
String The alternate merchant ID.
AutoCloseBatch (optional)
Boolean Whether to auto-close batches, default is true.
AutoCloseBatchTimestamp (optional)
Date When to auto-close batches, default is 10:00 PM. format: date-time
ForceDuplicate (optional)
Boolean Whether to force duplicates, default is true.
RequirePNRef (optional)
IsTestMerchant (optional)
Boolean Whether this is a test merchant, default is false.
ActivationStatus
Pending
Active
Inactive
Deleted
EnableFraud (optional)
EnableOfflineBatch (optional)
Boolean Whether to enable offline batching.
AllowHostedPage (optional)
Boolean Whether to allow hosted page, default is true.
AllowEmulator (optional)
Boolean Whether to allow emulator, default is true.
LimitToDebit (optional)
CollectLevel3 (optional)
Boolean Whether to collect level 3.
PutRegister
RegisterKey
Integer The key of the register to be edited. format: int32
ActivationStatus
Pending
Active
Inactive
Deleted
RegisterName (optional)
TerminalNumber (optional)
TerminalNumber2 (optional)
String The second terminal number.
ProcessorId
QuickPaymentsKeyResponse
QuickPaymentsKey (optional)
String The QuickPaymentsJS key added.
QuickPaymentsTokenResponse
QuickPaymentsToken (optional)
String The QuickPayments token added.
RegisterDetail
RegisterKey (optional)
Integer The unique identifier for this register. format: int32
MerchantKey (optional)
Integer The key of the merchant that is associated with this register. format: int32
RegisterNumber (optional)
String The number of the register.
RegisterName (optional)
String The name of the register.
TerminalNumber (optional)
String The primary terminal number for the register.
TerminalNumber2 (optional)
String An additional terminal number for the register.
ProcessorId (optional)
String Indicates the processor used by the register.
ActivationStatus (optional)
String Indicates the current activation status of the record.
LastUpdateTimestamp (optional)
Date Indicates when the register was last edited. format: date-time
ResponseError
ErrorCode (optional)
FieldName (optional)
Message (optional)
Meta (optional)
ResponseStatus
ErrorCode (optional)
Message (optional)
StackTrace (optional)
Errors (optional)
Meta (optional)
SettlementBatch
BatchId (optional)
BatchDate (optional)
Date The timestamp of the batch format: date-time
Processor (optional)
String The processor of the batch
Message (optional)
String The settlement message for the batch
TransactionCount (optional)
Integer The count of transactions in the batch format: int32
SaleAmount (optional)
Double The sum of sale amounts in the batch format: double
ReturnAmount (optional)
Double The sum of return amounts in the batch format: double
TotalAmount (optional)
Double The sum of total amounts in the batch format: double
MID (optional)
String The ID of the merchant of the batches
SettlementBatchResults
MerchantName (optional)
String The name of the merchant of the batches
Batches (optional)
Pagination (optional)
SignatureData
signatureType (optional)
String Identifies the format of the signature data being provided
data (optional)
String This parameter holds the data string containing the signature data. If SignatureType = Signature4, the SignatureData will contain a string value of vector coordinates, delimited with a ^ character in the following format: x1,y1^x2,y2^xN,yN^~ Where ^ is the coordinate delimiter, ~ is the ending delimiter, and a comma (,) is the vector delimiter. If there is a pen up event, use the coordinate 0,65535 to signal a break in the line. If SignatureType = Receipt1, you must compress and Base64 encode the image data.
SoftDescriptor
AltMerchantName (optional)
String Contains the merchant name/product/service to be used in lieu of the DBA name on file.
AltMerchantAddress (optional)
String Contains the merchant address to be used in lieu of the merchant address on file.
AltMerchantCity (optional)
String Contains the merchant city to be used in lieu of the merchant city on file.
AltMerchantState (optional)
String Contains the merchant state to be used in lieu of the merchant state on file.
AltMerchantZip (optional)
String Contains the merchant zip to be used in lieu of the merchant zip on file.
Transaction
amountData (optional)
AmountData Amounts associated with the transaction.
hostCode (optional)
String Optional host code/transaction id.
authCode (optional)
merchantKey (optional)
Integer System-generated unique identifier of the merchant. format: int32
resultCode (optional)
Integer Gateway code indicating the result of the transaction or error. format: int32
resultText (optional)
String Short description of the transaction result.
pnRef (optional)
Integer Gateway transaction ID/reference number. format: int32
message (optional)
String Text description of the transaction result or error.
message1 (optional)
String Text description of the transaction result or error.
message2 (optional)
String Text description of the transaction result or error.
binData (optional)
BinData Data returned from a BIN lookup on the card.
validationData (optional)
customFields (optional)
token (optional)
String A token for this transaction.
TransactionDetail
PnRef (optional)
Integer The PnRef (unique identifier) of the transaction. format: int32
InvoiceNumber (optional)
String The invoice number submitted on the transaction.
SequenceNumber (optional)
String The transaction's Sequence Number.
TransactionTimestamp (optional)
Date The timestamp of the transaction. format: date-time
AuthorizationTimestamp (optional)
Date The timestamp of the authorization. format: date-time
MerchantKey (optional)
Integer Merchant key on the transaction. format: int32
UserName (optional)
String Username that initiated the transaction.
RegisterNumber (optional)
String Register used in the transaction.
ResellerKey (optional)
Integer Reseller key on the transaction. format: int32
PaymentType (optional)
String Payment type used in the transaction.
TransactionType (optional)
String The transaction type processed (sale, return, etc.).
Processor (optional)
String The processor of the transaction.
SettlementMessage (optional)
VoidFlag (optional)
String Indicates if the transaction has been voided.
SettleFlag (optional)
String Indicates if the transaction has been settled.
SettlementTimestamp (optional)
Date The timestamp of the transaction's settlement format: date-time
IP (optional)
String IP address from which the transaction was processed.
CustomerId (optional)
String Customer Id on the transaction.
OriginalTransactionPnRef (optional)
Integer The PnRef of the original transaction (if this was a follow-on transaction). format: int32
CustomerReference (optional)
String Additional customer reference.
BatchNumber (optional)
String The batch number to which the transaction belongs.
BatchSequenceNumber (optional)
String Sequence number of the batch.
Adjusted (optional)
String Indicates if the transaction has been adjusted.
TransactionFinishTimestamp (optional)
Date The timestamp for the completion of the transaction. format: date-time
ProcessorRequestTimestamp (optional)
Date The timestamp for beginning the processor communication. format: date-time
ProcessorResponseTimestamp (optional)
Date The timestamp for ending the processor communication. format: date-time
BatchId (optional)
String The Id for the batch this transaction was a member of.
ReversalFlag (optional)
String Indicates if the transaction has been reversed.
CardDetail (optional)
CardDetail Selected details of the transaction's card data (if present).
CheckDetail (optional)
CheckDetail Selected details of the transaction's check data (if present).
CashDetail (optional)
CashDetail Selected details of the transaction's cash data (if present).
CustomFields (optional)
TransactionDetailResults
Transactions (optional)
Pagination (optional)