FIfirefinancialservices
API and Webhooks

Create an API Application

Changed on

This endpoint will create a new API Application on your Fire account with your chosen specified permissions. Please note that if there is no batch approval permissions included, the approval fields must be set to null. You will need to enable PERM_BUSINESS_POST_APPS to use this endpoint.

post/v1/apps

Request

Request body

applicationNamestring

A name for the API Application to help you identify it

numberOfPaymentApprovalsRequiredinteger

Number of approvals required to process a payment in a batch

numberOfPayeeApprovalsRequiredinteger

Number of approvals required to create a payee in a batch

isPayeeCheckEnabledboolean

This is whether or not Verfication of Payee checks are required for SEPA payments before a batch can be submitted.

permissionsstring[]

The list of permissions required

Example request

{
  "applicationName": "Batch Processing API",
  "numberOfPaymentApprovalsRequired": 1,
  "numberOfPayeeApprovalsRequired": 1,
  "permissions": [
    "PERM_BUSINESS_POST_PAYMENT_REQUEST",
    "PERM_BUSINESS_GET_ASPSPS"
  ]
}

Response

API Application created successfully

clientIdstring

This is the ID of client associated with the application

refreshTokenstring

This is the refresh token associated with the application

clientKeystring

The Client Key of the new API Application

Example response

{
  "clientId": "G0919C06D23D-362A-H5D3-E76D8687D6AE",
  "refreshToken": "9C332CF3-1687-4548-8E0E-55E4F0599800",
  "clientKey": "4ADFB67A-0F5B-4A9A-9D74-34437250045C"
}

Changes

  • v11d19896d095cRevision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property