curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/merchants \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/merchants"
payload = {}
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({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/merchants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/merchants';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"message": "<string>",
"code": "<string>",
"data": [
{
"billingAddress": {
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"email": "<string>",
"phone": "<string>",
"isDeleted": true,
"_id": "<string>",
"subMerchantId": "<string>",
"name": "<string>",
"creditCards": [
{
"truncatedCardNumber": "<string>",
"cardHolderName": "<string>",
"expirationDate": "<string>",
"token": "<string>",
"tokenID": "<string>",
"cardLogo": "<string>",
"tokenProvider": "<string>",
"tokenNewlyGenerated": "<string>",
"servicesId": "<string>",
"status": "<string>",
"isDefault": true,
"isDeleted": true,
"createdAt": "<string>"
}
],
"bankAccounts": [
{}
],
"createdAt": "<string>",
"__v": 123
}
],
"count": 123,
"query": {
"criteria": {
"isDeleted": {
"$in": [
true
]
}
},
"options": {
"fields": {
"_id": 123,
"createdAt": 123,
"updatedAt": 123,
"name": 123,
"email": 123,
"mobileNumber": 123,
"account": 123,
"spProductId": 123,
"subMerchantId": 123,
"identity": 123,
"status": 123,
"processor.wpId": 123,
"accountNumber": 123,
"identity.business.websiteUrl": 123,
"identity.business.legalName": 123,
"identity.business.dbaName": 123,
"identity.business.address": 123
}
}
}
}List merchants
Returns the merchants under your platform, including profile details and operational status.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/merchants \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/merchants"
payload = {}
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({})
};
fetch('https://sandbox-platform.jupico.com/v1/query/merchants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/merchants';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"message": "<string>",
"code": "<string>",
"data": [
{
"billingAddress": {
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>"
},
"email": "<string>",
"phone": "<string>",
"isDeleted": true,
"_id": "<string>",
"subMerchantId": "<string>",
"name": "<string>",
"creditCards": [
{
"truncatedCardNumber": "<string>",
"cardHolderName": "<string>",
"expirationDate": "<string>",
"token": "<string>",
"tokenID": "<string>",
"cardLogo": "<string>",
"tokenProvider": "<string>",
"tokenNewlyGenerated": "<string>",
"servicesId": "<string>",
"status": "<string>",
"isDefault": true,
"isDeleted": true,
"createdAt": "<string>"
}
],
"bankAccounts": [
{}
],
"createdAt": "<string>",
"__v": 123
}
],
"count": 123,
"query": {
"criteria": {
"isDeleted": {
"$in": [
true
]
}
},
"options": {
"fields": {
"_id": 123,
"createdAt": 123,
"updatedAt": 123,
"name": 123,
"email": 123,
"mobileNumber": 123,
"account": 123,
"spProductId": 123,
"subMerchantId": 123,
"identity": 123,
"status": 123,
"processor.wpId": 123,
"accountNumber": 123,
"identity.business.websiteUrl": 123,
"identity.business.legalName": 123,
"identity.business.dbaName": 123,
"identity.business.address": 123
}
}
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
The body is of type object.
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
Email address.
Phone number.
Whether the record is soft-deleted.
Internal document identifier.
Unique identifier of the submerchant.
Display name.
Cards stored for the customer.
Hide child attributes
Hide child attributes
Masked card number.
Name of the cardholder.
Card expiration date.
The token value.
Stored token identifier.
Card brand logo identifier.
Provider of the stored token.
Whether the token was newly generated on this request.
Identifier of the token at the tokenization service.
Current status.
Whether this is the customer's default payment method.
Whether the record is soft-deleted.
Timestamp when the object was created (ISO 8601).
Bank accounts stored for the customer.
Timestamp when the object was created (ISO 8601).
Internal document version. Ignore.
Number of records.
Echo of the query envelope that produced this result.
Hide child attributes
Hide child attributes
Query options: pagination, sorting, and field projection.
Hide child attributes
Hide child attributes
Field projection: keys map to 1 (include) or 0 (exclude).
Hide child attributes
Hide child attributes
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Set to 1 to include this field in results, or 0 to exclude it.
Was this page helpful?

