get
https://api-cert.sagepayments.com/bankcard/v1 /credits
Name | Values | Description |
---|---|---|
type |
The type of transaction, valid values are "Sale", "Authorization", "Force", "Void", "Credit", "CreditByReference", "Capture" |
|
startDate |
Returns records on or after this date |
|
endDate |
Returns records on or before this date |
|
pageSize |
The number of items to be included in each page of the result set |
|
pageNumber |
The page number of the result set to return |
|
sortDirection |
The direction in which results should be sorted |
|
sortField |
The field on which results should be sorted. This can be any field in the response object. |
|
isPurchaseCard |
Whether the bankcard transaction was a purchase card |
|
name |
Used to query credits by various criteria including amount, date, order number, type, etc. Results include both summarized information and itemized detail. |
|
accountNumber |
The last 4 digits of the customer's credit card number |
|
source |
The type of application from which the transaction originated |
|
orderNumber |
The transaction's order number |
|
reference |
The transaction's unique reference number |
|
batchReference |
The batch's unique reference number |
|
totalAmount |
The total amount of the transaction |
|
approvalCode |
The six-digit approval code returned by the host |
Name | Values | Description |
---|---|---|
clientId
(required) |
Application Identifier also known as API Key |
|
merchantId
(required) |
Merchant Identifier |
|
merchantKey
(required) |
Merchant Key |
|
nonce
(required) |
Secure random number used only once |
|
timestamp
(required) |
Epoch time stamp |
|
Authorization
(required) |
Authorization token, HMAC value of: verb + url + body + merchantId + nonce + timestamp |
|
Content-Type
(required) |
Valid values are "application/json" |
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.
Bad Request
Unauthorized
Resource Summary |
|
Security |
|
Content Type |
application/json |
Category |
Credits |
Name | Type | Description |
---|
Name | Type | Description |
---|
{ "code": "<error code>", "message": "<error message>", "info": "<url to error page>", "detail": "<error details>" }Please visit our error page for additional information
Type | Card Numbers |
---|---|
Visa | |
MasterCard | |
American Express | |
Discover |
Working...