curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/transactions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"processing[batchDate]": "2023-12-25",
"metadata.test": "test"
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/query/transactions"
payload = {
"processing[batchDate]": "2023-12-25",
"metadata.test": "test"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({'processing[batchDate]': '2023-12-25', 'metadata.test': 'test'})
};
fetch('https://sandbox-platform.jupico.com/v1/query/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/transactions';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({'processing[batchDate]': '2023-12-25', 'metadata.test': 'test'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"message": "<string>",
"code": "<string>",
"data": [
{
"review": {
"enabled": true,
"logs": [
"<string>"
]
},
"billing": {
"name": "<string>",
"email": "<string>",
"address": "<string>",
"city": "<string>",
"zipCode": "<string>",
"state": "<string>",
"country": "<string>",
"phone": "<string>"
},
"shipping": {
"address": "<string>",
"city": "<string>",
"zipCode": "<string>",
"state": "<string>",
"country": "<string>",
"email": "<string>",
"name": "<string>",
"phone": "<string>"
},
"processing": {
"fees": {
"applied": true
},
"chargebacks": [
"<string>"
],
"logs": [
{
"status": "<string>",
"createdAt": "<string>"
}
],
"status": "<string>",
"updatedAt": "<string>"
},
"paymentMethod": {
"cc": {
"card": {
"last4Digits": "<string>",
"expirationYear": "<string>",
"expirationMonth": "<string>",
"logo": "<string>"
}
},
"eCheck": {
"accountType": "<string>",
"routingNumber": "<string>",
"accountNumberLast4": "<string>",
"checkNumber": "<string>",
"checkType": "<string>",
"bankAccToken": "<string>"
}
},
"amount": 123,
"balanceAmount": 123,
"voided": true,
"taxAmount": 123,
"status": "<string>",
"transactionId": "<string>",
"operation": "<string>",
"subMerchantId": "<string>",
"customerId": "<string>",
"parentId": "<string>",
"referenceNumber": "<string>",
"txDate": "<string>",
"description": "<string>",
"approvalNumber": 123,
"createdAt": "<string>",
"feeId": "<string>"
}
],
"count": 123,
"query": {
"criteria": {
"transactionId": 123
},
"options": {}
}
}List transactions
Returns transactions matching the supplied filters. Supports the standard query envelope for filtering (including metadata.<key>), sorting, and pagination.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/transactions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"processing[batchDate]": "2023-12-25",
"metadata.test": "test"
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/query/transactions"
payload = {
"processing[batchDate]": "2023-12-25",
"metadata.test": "test"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({'processing[batchDate]': '2023-12-25', 'metadata.test': 'test'})
};
fetch('https://sandbox-platform.jupico.com/v1/query/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/transactions';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({'processing[batchDate]': '2023-12-25', 'metadata.test': 'test'})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"message": "<string>",
"code": "<string>",
"data": [
{
"review": {
"enabled": true,
"logs": [
"<string>"
]
},
"billing": {
"name": "<string>",
"email": "<string>",
"address": "<string>",
"city": "<string>",
"zipCode": "<string>",
"state": "<string>",
"country": "<string>",
"phone": "<string>"
},
"shipping": {
"address": "<string>",
"city": "<string>",
"zipCode": "<string>",
"state": "<string>",
"country": "<string>",
"email": "<string>",
"name": "<string>",
"phone": "<string>"
},
"processing": {
"fees": {
"applied": true
},
"chargebacks": [
"<string>"
],
"logs": [
{
"status": "<string>",
"createdAt": "<string>"
}
],
"status": "<string>",
"updatedAt": "<string>"
},
"paymentMethod": {
"cc": {
"card": {
"last4Digits": "<string>",
"expirationYear": "<string>",
"expirationMonth": "<string>",
"logo": "<string>"
}
},
"eCheck": {
"accountType": "<string>",
"routingNumber": "<string>",
"accountNumberLast4": "<string>",
"checkNumber": "<string>",
"checkType": "<string>",
"bankAccToken": "<string>"
}
},
"amount": 123,
"balanceAmount": 123,
"voided": true,
"taxAmount": 123,
"status": "<string>",
"transactionId": "<string>",
"operation": "<string>",
"subMerchantId": "<string>",
"customerId": "<string>",
"parentId": "<string>",
"referenceNumber": "<string>",
"txDate": "<string>",
"description": "<string>",
"approvalNumber": 123,
"createdAt": "<string>",
"feeId": "<string>"
}
],
"count": 123,
"query": {
"criteria": {
"transactionId": 123
},
"options": {}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
Response
Successful eCheckSale
Whether the request was processed successfully. Declines return HTTP 200 with success: false.
Human-readable result message.
Machine-readable result code. See the Error Codes reference.
The response payload.
Hide child attributes
Hide child attributes
Billing contact and address details for the payer.
Hide child attributes
Hide child attributes
Full name of the payer.
Email address of the payer.
Street address, including number.
City name.
ZIP or postal code.
Two-letter US state code.
Two-letter ISO 3166-1 country code.
Phone number of the payer.
Shipping contact and address details for the order.
Hide child attributes
Hide child attributes
Street address, including number.
City name.
ZIP or postal code.
Two-letter US state code.
Two-letter ISO 3166-1 country code.
Email address of the recipient.
Name of the recipient.
Phone number of the recipient.
Processing details, including fees and batch information.
Hide child attributes
Hide child attributes
Chargebacks linked to this transaction.
Current status.
Timestamp when the object was last updated (ISO 8601).
Details of the payment method used.
Hide child attributes
Hide child attributes
Card payment method details.
Hide child attributes
Hide child attributes
Card details.
Hide child attributes
Hide child attributes
Last 4 digits of the card number.
Two-digit expiration year.
Two-digit expiration month (01-12).
Card brand logo identifier.
eCheck (ACH) acceptance settings.
Hide child attributes
Hide child attributes
Bank account type, such as checking.
9-digit ABA routing number.
Last 4 digits of the bank account number.
Check number to record with this debit.
Type of check used for the debit.
Token of the bank account.
The amount of the transaction.
Remaining balance on the transaction after captures, refunds, and voids.
Whether the transaction has been voided.
Sales tax portion of the amount.
Current status.
Unique identifier of the original transaction.
Transaction operation type (for example, sale, authorization, refund).
Unique identifier of the submerchant.
Unique identifier of the customer.
Identifier of the parent transaction (for example, the authorization behind a capture).
Processor reference number for the transaction.
Date and time of the transaction (ISO 8601).
Free-text description.
Approval code returned by the issuing bank.
Timestamp when the object was created (ISO 8601).
Identifier of the fee record for this transaction.
Number of records.
Echo of the query envelope that produced this result.
Was this page helpful?

