--- updatedAt: 2026-07-24T08:27:13.000Z agentTools: projectIndex: https://docs.fire.com/llms.txt --- # List all direct debits This endpoint will retrieve all direct debit payments associated with a direct debit mandate. You will need to enable PERM_BUSINESS_GET_DIRECT_DEBITS to use this endpoint. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Fire Financial Services Business API", "description": "The fire.com API allows you to deeply integrate Business Account features into your application or back-office systems.\n", "version": "1.0", "contact": { "name": "Fire API", "url": "https://docs.fire.com", "email": "api@fire.com" } }, "servers": [ { "url": "https://api.fire.com/business", "description": "Production Server" } ], "paths": { "/v1/directdebits": { "get": { "summary": "List all direct debits", "description": "This endpoint will retrieve all direct debit payments associated with a direct debit mandate. You will need to enable PERM_BUSINESS_GET_DIRECT_DEBITS to use this endpoint.\n", "tags": [ "Direct Debits" ], "operationId": "getDirectDebitsForMandateUuid", "parameters": [ { "in": "query", "name": "mandateUuid", "schema": { "type": "string" }, "required": true, "description": "The mandate UUID to retrieve", "example": "1A07774B-1461-4595-BC4B-423B739712AF" } ], "responses": { "200": { "description": "Retrieve all direct debit payments associated with a direct debit mandate.", "content": { "application/json": { "schema": { "title": "directDebits", "type": "object", "properties": { "total": { "type": "integer", "format": "int64", "description": "Number of direct debits found", "example": 1 }, "directdebits": { "type": "array", "items": { "$ref": "#/components/schemas/DirectDebit" } } } } } } }, "400": { "description": "An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.", "content": { "application/json": { "schema": { "title": "apiErrors", "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "401": { "description": "An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.", "content": { "application/json": { "schema": { "title": "apiErrors", "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "403": { "description": "An error has occured. Any 403 errors usually mean your access token is invalid or missing. For other errors, check the validity of your input, and if you are permitted to access this endpoint.", "content": { "application/json": { "schema": { "title": "apiErrors", "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiError" } } } } } } } } } } }, "webhooks": { "webhook": { "post": { "summary": "Event Webhook", "tags": [ "Webhooks" ], "description": "Webhooks allow you to be notified of events as they happen on your Fire accounts. The below sample response shows how a webhook from Fire will arrive at your server. See our 'Webhooks' guide for more detailed information.", "requestBody": { "required": true, "content": { "application/jwt": { "schema": { "type": "string", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ" } } } }, "responses": { "200": { "description": "A 200 response is required from your server. Returns a 200 response to indicate that the data was received successfully." } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "API Access Token" } }, "schemas": { "ApiError": { "title": "apiError", "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "description": "Error Code", "example": 50051 }, "message": { "type": "string", "description": "The error message", "example": "Sorry, we are unable to proceed with your request." } } }, "Currency": { "title": "currency", "description": "The currency.", "type": "object", "properties": { "code": { "type": "string", "description": "The three letter code for the currency.", "example": "EUR" }, "description": { "type": "string", "description": "The name of the currency", "example": "Euro" } } }, "DirectDebit": { "title": "directDebit", "type": "object", "properties": { "directDebitUuid": { "type": "string", "description": "The UUID for the direct debit payment", "example": "42de0705-e3f1-44fa-8c41-79973eb80eb2" }, "currency": { "$ref": "#/components/schemas/Currency" }, "status": { "type": "string", "enum": [ "RECIEVED", "REJECT_REQUESTED", "REJECT_READY_FOR_PROCESSING", "REJECT_RECORD_IN_PROGRESS", "REJECT_RECORDED", "REJECT_FILE_CREATED", "REJECT_FILE_SENT", "COLLECTED", "REFUND_REQUESTED", "REFUND_RECORD_IN_PROGRESS", "REFUND_RECORDED", "REFUND_FILE_CREATED", "REFUND_FILE_SENT" ], "description": "The statuses of the direct debit payments associated with the mandate.\n* 'RECIEVED' - Direct Debit has been recieved\n* 'REJECT_REQUESTED' - The direct debit has a rejected request associated with it\n* 'REJECT_READY_FOR_PROCESSING' \n* 'REJECT_RECORD_IN_PROGRESS'\n* 'REJECT_RECORDED'\n* 'REJECT_FILE_CREATED'\n* 'REJECT_FILE_SENT'\n* 'COLLECTED' - Direct debit collected\n* 'REFUND_REQUESTED' - Refund requested on direct debit\n* 'REFUND_RECORD_IN_PROGRESS' - Refund in progress on direct debit\n* 'REFUND_RECORDED'\n* 'REFUND_FILE_CREATED'\n* 'REFUND_FILE_SENT' \n", "example": "RECIEVED" }, "type": { "type": "string", "enum": [ "FIRST_COLLECTION", "ONGOING_COLLECTION", "REPRESENTED_COLLECTION", "FINAL_COLLECTION" ], "description": "The type of the direct debit.", "example": "FIRST_COLLECTION" }, "mandateUUid": { "type": "string", "description": "The UUID for the mandate", "example": "f171b143-e3eb-47de-85a6-1c1f1108c701" }, "originatorReference": { "type": "string", "description": "Set by party who sets up the direct debit.", "example": "VODA-123456" }, "originatorName": { "type": "string", "description": "The creator of the party who sets up the direct debit.", "example": "Vodafone PLC" }, "originatorAlias": { "type": "string", "description": "The Alias of the party who sets up the direct debit.", "example": "Three" }, "directDebitReference": { "type": "string", "description": "The direct debit reference.", "example": "VODA-ABC453-1" }, "targetIcan": { "type": "integer", "format": "int64", "description": "The ican of your fire account that the money was taken from", "example": 42 }, "targetPayeeId": { "type": "integer", "format": "int64", "description": "The payee that was created when the DD was processed", "example": 12 }, "isDDIC": { "type": "boolean", "description": "DDIC is a Direct Debit Indemnity Claim (i.e.a refund). If if the DD is requested to be refunded it is marked isDDIC true.", "example": false }, "amount": { "type": "integer", "format": "int64", "description": "Value of the payment", "example": 100 }, "schemeRejectReason": { "type": "string", "description": "Reason why rejected", "example": "eg. Instruction cancelled by payer" }, "schemeRejectReasonCode": { "type": "string", "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "A", "B" ], "example": "for BACS (ARUDD) 0|1|2|3|5|6|7|8|9|A|B", "description": "The reject code returned by the bank indicating an issue with the direct debit. Each ARRUD code represents a rejection reason." }, "lastUpdated": { "type": "string", "format": "date-time", "description": "Date the direct debit was last updated. Milliseconds since the epoch (1970).", "example": "2016-12-15T22:56:05.937Z" }, "dateCreated": { "type": "string", "format": "date-time", "example": "2016-12-15T22:56:05.937Z", "description": "Date the direct debit was created. Milliseconds since the epoch (1970)." } } } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Direct Debits", "description": "The fire.com api allows businesses to automate direct debit payment actions on their fire.com business accounts." }, { "name": "Webhooks", "description": "Events you can receive in realtime" } ] } ```