curl --request POST \
--url https://api.firstpromoter.com/api/v2/company/payouts/create_payments_batch \
--header 'Account-ID: <account-id>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "paypal"
}
'{
"data": {
"id": 123,
"status": "awaiting_confirmation",
"ext_reference": "<string>",
"ext_id": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"processing_started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"is_payable": true,
"is_retriable": true,
"is_payment_otp_required": true,
"total": 123,
"promoters_count": 123,
"error": "<string>"
},
"meta": {
"failed": [
{}
]
}
}This endpoint creates a new payments batch.
POST https://api.firstpromoter.com/api/v2/company/payouts/create_payments_batchcurl --request POST \
--url https://api.firstpromoter.com/api/v2/company/payouts/create_payments_batch \
--header 'Account-ID: <account-id>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "paypal"
}
'{
"data": {
"id": 123,
"status": "awaiting_confirmation",
"ext_reference": "<string>",
"ext_id": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"processing_started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"is_payable": true,
"is_retriable": true,
"is_payment_otp_required": true,
"total": 123,
"promoters_count": 123,
"error": "<string>"
},
"meta": {
"failed": [
{}
]
}
}Access token passed as a Bearer token in the Authorization header
Account identifier that specifies which account is making the request
"acc_123456"
Payment method
paypal, bank, wise, crypto, dots Created
Show child attributes
ID of the payments batch
Status of the payments batch
awaiting_confirmation, pending, processing, completed, failed External reference
External ID
When the batch is scheduled
When processing started
When the batch was completed
Whether the batch is payable
Whether the batch can be retried
Whether OTP is required for payment
Total amount
Count of promoters
Error message if the batch failed