Skip to main content
GET
/
v1
/
transfers
/
batch
/
{batch_id}
Get batch transfer
curl --request GET \
  --url https://api.adullam.dev/v1/transfers/batch/{batch_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "batch_abc123",
  "status": "processing",
  "total_amount": 125000,
  "total_count": 2,
  "processed_count": 0,
  "successful_count": 0,
  "failed_count": 0,
  "pending_count": 2,
  "description": "Monthly salary batch",
  "reference": "SALARY_JAN_2024",
  "total_fees": 100,
  "transfers": [
    {
      "id": "txf_abc123",
      "status": "processing",
      "amount": 10000,
      "currency": "XOF",
      "recipient_phone": "+22507123456",
      "recipient_name": "DIALLO IBRAHIM",
      "channel": "mtnCI",
      "description": "Salary payment",
      "reference": "PAY_001",
      "ussd_reference": "MP240115.1032.T98765",
      "fees": 50,
      "metadata": {
        "employee_id": "EMP_123"
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "completed_at": null,
      "failure_reason": null
    }
  ],
  "created_at": "2024-01-15T10:00:00Z",
  "started_at": null,
  "completed_at": null
}

Get Batch Transfer

Retrieving a specific batch transfer allows you to view details of all transfers within that batch. Use the Get Batch Transfer API to access information such as total amount, status, and individual transfer details for a given batch ID.

Authorizations

Authorization
string
header
required

Use the access token obtained from /v1/auth/token

Path Parameters

batch_id
string
required

Response

Batch transfer details

id
string
Example:

"batch_abc123"

status
enum<string>
Available options:
pending,
processing,
completed,
failed,
partial_completed
Example:

"processing"

total_amount
integer
Example:

125000

total_count
integer
Example:

2

processed_count
integer
Example:

0

successful_count
integer
Example:

0

failed_count
integer
Example:

0

pending_count
integer
Example:

2

description
string
Example:

"Monthly salary batch"

reference
string
Example:

"SALARY_JAN_2024"

total_fees
integer
Example:

100

transfers
object[]
created_at
string<date-time>
Example:

"2024-01-15T10:00:00Z"

started_at
string<date-time> | null
Example:

null

completed_at
string<date-time> | null
Example:

null