API Reference

Create a new batch

post
https://api.fire.com/business/v1/batches

This endpoint will create a new batch. This opens a new batch container to hold specific transaction types in a certain currency. You will need to enable PERM_BUSINESS_POST_BATCHES to use this endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Details of the batch payment

string
enum

The type of the batch - can be one of the listed 3

Allowed:
string

3 digit ISO code for the currency you wish to send - GBP, EUR, USD, CAD, etc...

string

An optional name you give to the batch at creation time.

string

An optional job number you can give to the batch to help link it to your own system.

string

An optional POST URL that all events for this batch will be sent to.

Responses

Updated 8 months ago

Language
Credentials
Bearer
API Access Token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago