Get the details of a direct debit

v1.0.0

Retrieve all details of a single direct debit collection/payment, whether successful or not. The permision needed to access this endpoint is PERM_BUSINESS_GET_DIRECT_DEBIT

Input

{
  "type": "object",
  "properties": {
    "directDebitUuid": {
      "type": "string",
      "description": "The uuid of the direct debit to retrieve."
    }
  },
  "required": [
    "directDebitUuid"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "integer",
      "format": "int64",
      "description": "Value of the payment"
    },
    "currency": {
      "type": "object",
      "description": "The currency.",
      "properties": {
        "code": {
          "type": "string",
          "description": "The three letter code for the currency - either `EUR` or `GBP`.",
          "enum": [
            "EUR",
            "GBP"
          ]
        },
        "description": {
          "type": "string",
          "description": "The name of the currency"
        }
      }
    },
    "dateCreated": {
      "type": "string",
      "format": "date-time",
      "description": "Date the direct debit was created. Milliseconds since the epoch (1970)."
    },
    "directDebitReference": {
      "type": "string",
      "description": "The direct debit reference."
    },
    "directDebitUuid": {
      "type": "string",
      "description": "The UUID for the direct debit payment"
    },
    "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."
    },
    "lastUpdated": {
      "type": "string",
      "format": "date-time",
      "description": "Date the direct debit was last updated. Milliseconds since the epoch (1970)."
    },
    "mandateUUid": {
      "type": "string",
      "description": "The UUID for the mandate"
    },
    "originatorAlias": {
      "type": "string",
      "description": "The Alias of the party who sets up the direct debit."
    },
    "originatorName": {
      "type": "string",
      "description": "The creator of the party who sets up the direct debit."
    },
    "originatorReference": {
      "type": "string",
      "description": "Set by party who sets up the direct debit."
    },
    "schemeRejectReason": {
      "type": "string",
      "description": "Reason why rejected"
    },
    "schemeRejectReasonCode": {
      "type": "string",
      "description": "The reject code returned by the bank indicating an issue with the direct debit. Each ARRUD code represents a rejection reason.",
      "enum": [
        "0",
        "1",
        "2",
        "3",
        "4",
        "5",
        "6",
        "7",
        "8",
        "9",
        "A",
        "B"
      ]
    },
    "status": {
      "type": "string",
      "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",
      "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"
      ]
    },
    "targetIcan": {
      "type": "integer",
      "format": "int64",
      "description": "The ican of your fire account that the money was taken from"
    },
    "targetPayeeId": {
      "type": "integer",
      "format": "int64",
      "description": "The payee that was created when the DD was processed"
    },
    "type": {
      "type": "string",
      "description": "The type of the direct debit.",
      "enum": [
        "FIRST_COLLECTION",
        "ONGOING_COLLECTION",
        "REPRESENTED_COLLECTION",
        "FINAL_COLLECTION"
      ]
    }
  }
}