curl --request POST \
--url https://sandbox-platform.jupico.com/v1/payouts/instruction \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 100,
"bankAccountToken": "36373c28d4da12feb9bb54fd3753d434:41dec2092b58351f55ad26fa5d75035ddb9fcef4ca767b5cdbf45074cf652402",
"subMerchantId": "874767775004"
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/payouts/instruction"
payload = {
"amount": 100,
"bankAccountToken": "36373c28d4da12feb9bb54fd3753d434:41dec2092b58351f55ad26fa5d75035ddb9fcef4ca767b5cdbf45074cf652402",
"subMerchantId": "874767775004"
}
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({
amount: 100,
bankAccountToken: '36373c28d4da12feb9bb54fd3753d434:41dec2092b58351f55ad26fa5d75035ddb9fcef4ca767b5cdbf45074cf652402',
subMerchantId: '874767775004'
})
};
fetch('https://sandbox-platform.jupico.com/v1/payouts/instruction', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/payouts/instruction';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 100,
bankAccountToken: '36373c28d4da12feb9bb54fd3753d434:41dec2092b58351f55ad26fa5d75035ddb9fcef4ca767b5cdbf45074cf652402',
subMerchantId: '874767775004'
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"message": "<string>",
"data": {
"subMerchantId": "<string>",
"facId": "<string>",
"spProductId": "<string>",
"amount": 123,
"type": "<string>",
"beneficiary": "<string>",
"status": "<string>",
"batchPayoutId": "<string>",
"bankAccountToken": "<string>",
"mode": "<string>",
"payoutId": "<string>",
"accRoutingNum": 123,
"accountNumber": 123,
"accountType": "<string>",
"sourceType": "<string>"
}
}Create a payout instruction
Creates a payout instruction that sends funds from the submerchant’s available balance to a tokenized bank account. Check the balance first with Check available balance under Reporting & Queries.
curl --request POST \
--url https://sandbox-platform.jupico.com/v1/payouts/instruction \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 100,
"bankAccountToken": "36373c28d4da12feb9bb54fd3753d434:41dec2092b58351f55ad26fa5d75035ddb9fcef4ca767b5cdbf45074cf652402",
"subMerchantId": "874767775004"
}
'import requests
url = "https://sandbox-platform.jupico.com/v1/payouts/instruction"
payload = {
"amount": 100,
"bankAccountToken": "36373c28d4da12feb9bb54fd3753d434:41dec2092b58351f55ad26fa5d75035ddb9fcef4ca767b5cdbf45074cf652402",
"subMerchantId": "874767775004"
}
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({
amount: 100,
bankAccountToken: '36373c28d4da12feb9bb54fd3753d434:41dec2092b58351f55ad26fa5d75035ddb9fcef4ca767b5cdbf45074cf652402',
subMerchantId: '874767775004'
})
};
fetch('https://sandbox-platform.jupico.com/v1/payouts/instruction', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://sandbox-platform.jupico.com/v1/payouts/instruction';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 100,
bankAccountToken: '36373c28d4da12feb9bb54fd3753d434:41dec2092b58351f55ad26fa5d75035ddb9fcef4ca767b5cdbf45074cf652402',
subMerchantId: '874767775004'
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"success": true,
"code": "<string>",
"message": "<string>",
"data": {
"subMerchantId": "<string>",
"facId": "<string>",
"spProductId": "<string>",
"amount": 123,
"type": "<string>",
"beneficiary": "<string>",
"status": "<string>",
"batchPayoutId": "<string>",
"bankAccountToken": "<string>",
"mode": "<string>",
"payoutId": "<string>",
"accRoutingNum": 123,
"accountNumber": 123,
"accountType": "<string>",
"sourceType": "<string>"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
create a payouts if sumerchant is in dynamic payouts.
Response
Successfuly create a payout
Whether the request was processed successfully. Declines return HTTP 200 with success: false.
Machine-readable result code. See the Error Codes reference.
Human-readable result message.
The response payload.
Hide child attributes
Hide child attributes
Unique identifier of the submerchant.
Facilitator identifier assigned by Jupico.
Identifier of the Service Provider product the merchant belongs to.
The amount of the transaction.
The type.
Name of the payout beneficiary.
Current status.
Identifier of the payout batch this instruction was grouped into.
Token of the bank account that receives the payout.
Payout mode.
Unique identifier of the payout instruction.
Routing number of the destination account.
Bank account number.
Bank account type, such as checking.
Balance source the payout draws from.
Was this page helpful?