---
updatedAt: 2026-07-24T08:27:13.000Z
agentTools:
  projectIndex: https://docs.fire.com/llms.txt
---

# Get the details of a direct debit mandate

This endpoint will allow you to retrieve all details for a direct debit mandate. You will need to enable PERM_BUSINESS_GET_MANDATE 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/mandates/{mandateUuid}": {
      "get": {
        "summary": "Get the details of a direct debit mandate",
        "description": "This endpoint will allow you to retrieve all details for a direct debit mandate. You will need to enable PERM_BUSINESS_GET_MANDATE to use this endpoint.\n",
        "tags": [
          "Direct Debits"
        ],
        "operationId": "getMandate",
        "parameters": [
          {
            "in": "path",
            "required": true,
            "name": "mandateUuid",
            "schema": {
              "type": "string",
              "description": "The uuid of the mandate to retrieve.",
              "example": "4ADFB67A-0F5B-4A9A-9D74-34437250045C"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Retrieve all details for a direct debit mandate.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Mandate"
                }
              }
            }
          },
          "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"
          }
        }
      },
      "Mandate": {
        "title": "mandate",
        "type": "object",
        "properties": {
          "mandateUuid": {
            "type": "string",
            "description": "The UUID for the mandate",
            "example": "28d627c3-1889-44c8-ae59-6f6b20239260"
          },
          "currency": {
            "$ref": "#/components/schemas/Currency"
          },
          "status": {
            "type": "string",
            "enum": [
              "CREATED",
              "LIVE",
              "REJECT_REQUESTED",
              "REJECT_RECORD_IN_PROGRESS",
              "REJECT_RECORDED",
              "REJECT_FILE_CREATED",
              "REJECT_FILE_SENT",
              "CANCEL_REQUESTED",
              "CANCEL_RECORD_IN_PROGRESS",
              "CANCEL_RECORDED",
              "CANCEL_FILE_CREATED",
              "CANCEL_FILE_SENT",
              "COMPLETE",
              "DORMANT"
            ],
            "description": "The status of the mandate.\n* 'CREATED'\n* 'LIVE'\n* 'REJECT_REQUESTED'\n* 'REJECT_RECORD_IN_PROGRESS'\n* 'REJECT_RECORDED'\n* 'REJECT_FILE_CREATED'\n* 'REJECT_FILE_SENT'\n* 'CANCEL_REQUESTED'\n* 'CANCEL_RECORD_IN_PROGRESS'\n* 'CANCEL_RECORDED'\n* 'CANCEL_FILE_CREATED'\n* 'CANCEL_FILE_SENT'\n* 'COMPLETE'\n* 'DORMANT'\n",
            "example": "RECIEVED"
          },
          "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",
            "example": "Vodaphone PLC",
            "description": "The name of the alias"
          },
          "originatorLogoUrlSmall": {
            "type": "string",
            "description": "Logo url from party who sets up the direct debit.",
            "example": "originatorLogoSmall"
          },
          "originatorLogoUrlLarge": {
            "type": "string",
            "description": "Logo url from party who sets up the direct debit.",
            "example": "originatorLogoLarge"
          },
          "mandateReference": {
            "type": "string",
            "example": "CRZ-102190123",
            "description": "the reference of the mandate"
          },
          "alias": {
            "type": "string",
            "example": "Vodaphone",
            "description": "The name of the alias"
          },
          "targetIcan": {
            "type": "integer",
            "format": "int64",
            "example": 1,
            "description": "Identifier for the fire.com account (assigned by fire.com)"
          },
          "numberOfDirectDebitCollected": {
            "type": "integer",
            "format": "int64",
            "example": 2,
            "description": "The number of direct debits collected"
          },
          "valueOfDirectDebitCollected": {
            "type": "integer",
            "format": "int64",
            "example": 2,
            "description": "The value of direct debits collected"
          },
          "latestDirectDebitAmount": {
            "type": "integer",
            "format": "int64",
            "example": 2,
            "description": "The value of largest direct debit collected"
          },
          "latestDirectDebitDate": {
            "type": "string",
            "format": "date-time",
            "example": "2016-12-15T22:56:05.937Z",
            "description": "The date of latest direct debit collected"
          },
          "fireRejectionReason": {
            "type": "string",
            "enum": [
              "ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS",
              "DDIC",
              "ACCOUNT_NOT_FOUND",
              "ACCOUNT_NOT_LIVE",
              "CUSTOMER_NOT_FOUND",
              "BUSINESS_NOT_LIVE",
              "BUSINESS_NOT_FULL",
              "PERSONAL_USER_NOT_LIVE",
              "PERSONAL_USER_NOT_FULL",
              "MANDATE_ALREADY_EXISTS",
              "MANDATE_WITH_DIFERENT_ACCOUNT",
              "NULL_MANDATE_REFERENCE",
              "INVALID_ACCOUNT_CURRENCY",
              "INVALID_MANDATE_REFERENCE",
              "REQUESTED_BY_CUSTOMER_VIA_SUPPORT",
              "CUSTOMER_ACCOUNT_CLOSED",
              "CUSTOMER_DECEASED",
              "ACCOUNT_TRANSFERRED",
              "MANDATE_NOT_FOUND",
              "ACCOUNT_TRANSFERRED_TO_DIFFERENT_ACCOUNT",
              "INVALID_ACCOUNT_TYPE",
              "MANDATE_EXPIRED",
              "MANDATE_CANCELLED",
              "REQUESTED_BY_CUSTOMER"
            ],
            "description": "Rejection reason if transaction is rejected",
            "example": "ACCOUNT_DOES_NOT_ACCEPT_DIRECT_DEBITS"
          },
          "schemeCancelReason": {
            "type": "string",
            "description": "Reason for cancelation",
            "example": "e.g. Instruction cancelled by payer"
          },
          "schemeCancelReasonCode": {
            "type": "string",
            "example": "For BACS (ADDACS) - 0|1|2|3|B|C|D|E|R",
            "description": "The cancelation 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)."
          },
          "dateCompleted": {
            "type": "string",
            "format": "date-time",
            "example": "2016-12-15T22:56:05.937Z",
            "description": "Date the direct debit was completed. Milliseconds since the epoch (1970)."
          },
          "dateCancelled": {
            "type": "string",
            "format": "date-time",
            "example": "2016-12-15T22:56:05.937Z",
            "description": "Date the direct debit was canceled. 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"
    }
  ]
}
```