curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/payouts/instructions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/payouts/instructions"
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/payouts/instructions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/payouts/instructions';
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": [
{
"_id": "<string>",
"review": {
"enabled": true,
"logs": [
"<string>"
]
},
"beneficiary": "<string>",
"status": "sent",
"feesIds": [
"<string>"
],
"subMerchantId": "<string>",
"spProductId": "<string>",
"amount": 123,
"createdAt": "<string>",
"batchPayoutId": "<string>",
"type": "<string>",
"accountNumber": "<string>",
"accountType": "<string>",
"countScheduled": 123,
"countTransactions": 123,
"updatedAt": "<string>"
}
],
"count": 123,
"query": {
"criteria": {
"isDeleted": {
"$in": [
true
]
}
},
"options": {
"fields": {
"_id": 123,
"transaction": 123,
"schedule": 123,
"chargeback": 123,
"platformFee": 123,
"spProductFee": 123,
"batchPayoutId": 123,
"status": 123,
"txDate": 123,
"fee": 123,
"type": 123,
"subMerchantId": 123,
"spProductId": 123,
"createdAt": 123,
"updatedAt": 123,
"review": 123
}
}
}
}List payout instructions
Returns payout instructions and their statuses.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/query/payouts/instructions \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://sandbox-platform.jupico.com/v1/query/payouts/instructions"
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/payouts/instructions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/query/payouts/instructions';
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": [
{
"_id": "<string>",
"review": {
"enabled": true,
"logs": [
"<string>"
]
},
"beneficiary": "<string>",
"status": "sent",
"feesIds": [
"<string>"
],
"subMerchantId": "<string>",
"spProductId": "<string>",
"amount": 123,
"createdAt": "<string>",
"batchPayoutId": "<string>",
"type": "<string>",
"accountNumber": "<string>",
"accountType": "<string>",
"countScheduled": 123,
"countTransactions": 123,
"updatedAt": "<string>"
}
],
"count": 123,
"query": {
"criteria": {
"isDeleted": {
"$in": [
true
]
}
},
"options": {
"fields": {
"_id": 123,
"transaction": 123,
"schedule": 123,
"chargeback": 123,
"platformFee": 123,
"spProductFee": 123,
"batchPayoutId": 123,
"status": 123,
"txDate": 123,
"fee": 123,
"type": 123,
"subMerchantId": 123,
"spProductId": 123,
"createdAt": 123,
"updatedAt": 123,
"review": 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
findAllPayoutInstructions
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
Internal document identifier.
Name of the payout beneficiary.
Current status of the payout instruction:
pending— created and awaiting approval. This is the only status in which a payout can be voided.ack— approved for sending.processing— being sent.on-hold— held for review.sent— sent to the bank. This is the final success status: it means Jupico handed the payout to the bank, not that the bank confirmed the funds reached the beneficiary's account. There is no separate "arrived" status; funds typically land within a few business days.voided— cancelled before it was sent.
pending, ack, processing, on-hold, sent, voided "sent"
Identifiers of fee records included.
Unique identifier of the submerchant.
Identifier of the Service Provider product the merchant belongs to.
The amount of the transaction.
Timestamp when the object was created (ISO 8601).
Identifier of the payout batch this instruction was grouped into.
The type.
Bank account number.
Bank account type, such as checking.
Number of scheduled payouts included.
Number of transactions included.
Timestamp when the object was last updated (ISO 8601).
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.
Was this page helpful?

