Get a bulk transfer

get

https://api.flutterwave.com/v3/transfers?batch_id

Get the status of a bulk transfer on your account

Query Params

batch_id

int32

required

Defaults to 26251

This is the numeric ID of the bulk transfer you want to fetch. It is returned in the call to create a bulk transfer as data.id.

page

string

Defaults to 1

This allows you fetch from a specific page e.g. setting 1 retrieves the first page.

from

string

Defaults to 2023-12-03

This is the start date for the query.

string

Defaults to 2025-01-06

This is the end date for the query.

include_proof

boolean

Defaults to false

This flags adds the proof (session id) of the transfer to the response.

include_provider_ref

boolean

Defaults to false

This flag include the provider reference for the transfer in the response.

include_approver_info

boolean

Defaults to false

This flag adds the approval information for the transfers to the response.

include_vat

boolean

Defaults to false

This flag includes the transfers' VAT information in the response.

include_rate

boolean

Defaults to false

This flag include the FX rate used for the transfer in the response.

include_debit_currency

boolean

Defaults to false

This flag include the debit currency for the transfer in the response.

include_retry_tag

string

This flag indicates whether the transfers were retried or not.

Headers

Authorization

string

required

Defaults to Bearer FLWSECK_TEST-SANDBOXDEMOKEY-X

Pass your secret key as a bearer token in the request header to authorize this call

Responses

200200

400400