---
updatedAt: 2026-08-11T08:29:13.000Z
agentTools:
  projectIndex: https://docs.payadvantage.com.au/llms.txt
---

# Retrieve a Direct Debit Instalment

Returns a single instalment by its unique identifier, including payment history.

# OpenAPI definition

```json
{
  "openapi": "3.0.4",
  "info": {
    "title": "PayAdvantage Web API",
    "termsOfService": "https://www.payadvantage.com.au/terms-of-service",
    "contact": {
      "name": "Support",
      "url": "https://help.payadvantage.com.au/hc/en-us/categories/360000110195",
      "email": "support@payadvantage.com.au"
    },
    "version": "v3"
  },
  "servers": [
    {
      "url": "https://api.test.payadvantage.com.au/v3/"
    }
  ],
  "paths": {
    "/direct_debit_instalments/{code}": {
      "get": {
        "tags": [
          "Direct Debit Instalment"
        ],
        "summary": "Retrieve a Direct Debit Instalment",
        "description": "Returns a single instalment by its unique identifier, including payment history.",
        "operationId": "direct_debit_instalments_get",
        "parameters": [
          {
            "name": "code",
            "in": "path",
            "description": "Unique identifier for the instalment.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The requested Direct Debit Instalment.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DirectDebitInstallmentDetailResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "User is not authorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "The requested resource could not be found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "The request was well-formed but was unable to be followed due to semantic errors",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "429": {
            "description": "Request limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "504": {
            "description": "Gateway timeout",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ApiErrorResponse": {
        "type": "object",
        "properties": {
          "ErrorCode": {
            "type": "string",
            "nullable": true,
            "example": "abc"
          },
          "Messages": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CodeOnly": {
        "type": "object",
        "properties": {
          "Code": {
            "pattern": "^[0-9A-Z]{6}$",
            "type": "string",
            "description": "The entities code.",
            "nullable": true,
            "example": "ABC123"
          }
        },
        "additionalProperties": false,
        "example": {
          "Code": "ABC123"
        }
      },
      "DirectDebitInstallmentDetailResponse": {
        "required": [
          "Amount",
          "CanEdit",
          "DateScheduled",
          "EstimatedFee",
          "HasAmountChanged",
          "HasDateChanged",
          "IsCatchUp",
          "IsMissed",
          "IsUpfront",
          "OriginalAmount",
          "ReminderSent"
        ],
        "type": "object",
        "properties": {
          "OriginalAmount": {
            "type": "number",
            "description": "The original scheduled amount before any adjustments.",
            "format": "double",
            "example": 1.23
          },
          "HasAmountChanged": {
            "type": "boolean",
            "description": "Whether the instalment amount has been changed from the original.",
            "example": true
          },
          "HasDateChanged": {
            "type": "boolean",
            "description": "Whether the instalment date has been changed from the original.",
            "example": true
          },
          "CanEdit": {
            "type": "boolean",
            "description": "Whether this instalment can be edited (date or amount).",
            "example": true
          },
          "IsMissed": {
            "type": "boolean",
            "description": "Whether this instalment has been missed.",
            "example": true
          },
          "IsUpfront": {
            "type": "boolean",
            "description": "Whether this instalment is the upfront payment.",
            "example": true
          },
          "EditRules": {
            "$ref": "#/components/schemas/DirectDebitInstallmentEditRules"
          },
          "DDR": {
            "$ref": "#/components/schemas/CodeOnly"
          },
          "Code": {
            "type": "string",
            "description": "Unique identifier for the installment.",
            "format": "uuid"
          },
          "DateScheduled": {
            "pattern": "^\\d\\d\\d\\d\\-\\d\\d\\-\\d\\d$",
            "type": "string",
            "description": "The date that the installment is scheduled to be processed.",
            "format": "date",
            "example": "2022-12-31"
          },
          "DateProcessed": {
            "pattern": "\\d\\d\\d\\d\\-\\d\\d\\-\\d\\dT\\d\\d:\\d\\d(:\\d\\d(\\.\\d{1,7})?(Z|([+\\-]\\d\\d:\\d\\d))?)?",
            "type": "string",
            "description": "The date and time that the installment was processed, otherwise null.",
            "format": "date",
            "nullable": true,
            "example": "2022-12-31"
          },
          "Amount": {
            "type": "number",
            "description": "The installment amount excluding any fees.",
            "format": "double",
            "example": 1.23
          },
          "EstimatedFee": {
            "type": "number",
            "description": "The estimated fee amount for the installment. This amount does not include unpaid installment fees.",
            "format": "double",
            "example": 1.23
          },
          "ReminderSent": {
            "type": "boolean",
            "description": "Indicates whether an upcoming installment reminder has been sent to the customer.",
            "example": true
          },
          "IsCatchUp": {
            "type": "boolean",
            "description": "Indicates if the installment is a catch-up installment for a previously missed installment.",
            "example": true
          },
          "Payment": {
            "$ref": "#/components/schemas/DirectDebitPaymentResponse"
          }
        },
        "additionalProperties": false,
        "description": "Detailed view of a direct debit instalment with edit capabilities."
      },
      "DirectDebitInstallmentEditRules": {
        "type": "object",
        "properties": {
          "MinDate": {
            "type": "string",
            "description": "Earliest allowed date for rescheduling.",
            "nullable": true,
            "example": "abc"
          },
          "MaxDate": {
            "type": "string",
            "description": "Latest allowed date for rescheduling.",
            "nullable": true,
            "example": "abc"
          }
        },
        "additionalProperties": false,
        "description": "Edit constraints for an instalment."
      },
      "DirectDebitPaymentResponse": {
        "required": [
          "IsFailed"
        ],
        "type": "object",
        "properties": {
          "Code": {
            "type": "string",
            "description": "Unique code identifier for the payment.",
            "nullable": true,
            "example": "abc"
          },
          "Status": {
            "$ref": "#/components/schemas/PaymentStatusIDs"
          },
          "IsFailed": {
            "type": "boolean",
            "description": "Whether this payment has failed.",
            "example": true
          }
        },
        "additionalProperties": false,
        "description": "The payment associated with an installment."
      },
      "PaymentStatusIDs": {
        "enum": [
          "Unknown",
          "pending",
          "processing",
          "succeeded",
          "failed",
          "undetermined",
          "agreement_created",
          "agreement_accepted",
          "settled"
        ],
        "type": "string"
      }
    }
  }
}
```