Execute Bulk Transfer

​

Overview

The Execute Bulk Transfer endpoint initiates the processing of all transfers within a prepared bulk transfer batch. This operation transitions the bulk transfer from created status to executing and begins processing individual transfers.

​

Endpoint

POST /bulk-transfers/{id}/execute

​

Path Parameters

​

Prerequisites

​

Example Request

curl -X POST "https://api.spendjuice.com/bulk-transfers/7d528558-1c20-4bb6-9a9a-a03c8292b297/execute" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"

​

Response Format

​

Success Response (202 Accepted)

{
  "data": {
    "id": "7d528558-1c20-4bb6-9a9a-a03c8292b297",
    "status": "executing",
    "total_transfer_count": 10,
    "successful_transfer_count": 0,
    "failed_transfer_count": 0,
    "created_at": "2024-03-15T10:30:00Z",
    "updated_at": "2024-03-15T10:35:00Z",
    "execution_started_at": "2024-03-15T10:35:00Z"
  }
}

​

Status Transitions

When a bulk transfer is executed, it goes through these status changes:

​

Webhook Events

Monitor these webhook events for bulk transfer status:

{
  "event": "bulk_transfer.executing",
  "data": {
    "id": "7d528558-1c20-4bb6-9a9a-a03c8292b297",
    "status": "executing",
    "total_transfer_count": 10
  }
}

{
  "event": "bulk_transfer.completed",
  "data": {
    "id": "7d528558-1c20-4bb6-9a9a-a03c8292b297",
    "status": "completed",
    "successful_transfer_count": 10,
    "failed_transfer_count": 0
  }
}

{
  "event": "bulk_transfer.failed",
  "data": {
    "id": "7d528558-1c20-4bb6-9a9a-a03c8292b297",
    "status": "failed",
    "error": {
      "code": "insufficient_balance",
      "message": "Insufficient balance for transfer"
    }
  }
}

​

Error Handling

​

Rate Limits

​

Best Practices

1. Pre-execution Validation

   • Verify all beneficiary details
   • Check sufficient balance
   • Validate transfer amounts
   • Monitor expiration time

2. Error Handling

   • Implement webhook handling
   • Monitor individual transfer status
   • Handle partial completions
   • Log execution attempts

3. Monitoring

   • Track execution progress
   • Monitor success rates
   • Set up alerts for failures
   • Review execution logs