---
updatedAt: 2026-08-04T04:27:55.000Z
agentTools:
  projectIndex: https://developers.akahu.nz/llms.txt
---

# Get available connections

Get the financial institution connections available to this application for one-off payments.

# OpenAPI definition

```json
{
  "info": {
    "title": "Akahu One-Off Payments API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "description": "Akahu One-off Payments API",
      "url": "https://api.payments.akahu.io"
    }
  ],
  "x-readme": {
    "apply-endpoint-order": true
  },
  "openapi": "3.1.0",
  "components": {
    "schemas": {
      "Generic400ErrorResponseCode": {
        "type": "string",
        "enum": [
          "invalid",
          "invalid_id",
          "not_found",
          "bad_request",
          "invalid_type",
          "invalid_literal",
          "invalid_union",
          "invalid_union_discriminator",
          "invalid_enum_value",
          "unrecognized_keys",
          "invalid_arguments",
          "invalid_return_type",
          "invalid_date",
          "invalid_string",
          "too_small",
          "too_big",
          "invalid_intersection_types",
          "not_multiple_of",
          "not_finite"
        ]
      },
      "IssuePath": {
        "type": "array",
        "items": {
          "title": "IssuePathSegment",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "number"
            }
          ]
        }
      },
      "Generic401ErrorResponseCode": {
        "type": "string",
        "enum": [
          "unauthorized"
        ]
      },
      "Generic401ErrorResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "message": {
            "type": "string"
          },
          "issues": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "$ref": "#/components/schemas/Generic401ErrorResponseCode"
                },
                "message": {
                  "type": "string"
                },
                "path": {
                  "$ref": "#/components/schemas/IssuePath"
                }
              },
              "required": [
                "code",
                "message",
                "path"
              ]
            }
          }
        },
        "required": [
          "success",
          "message",
          "issues"
        ]
      },
      "Generic403ErrorResponseCode": {
        "type": "string",
        "enum": [
          "forbidden"
        ]
      },
      "Generic403ErrorResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "message": {
            "type": "string"
          },
          "issues": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "$ref": "#/components/schemas/Generic403ErrorResponseCode"
                },
                "message": {
                  "type": "string"
                },
                "path": {
                  "$ref": "#/components/schemas/IssuePath"
                }
              },
              "required": [
                "code",
                "message",
                "path"
              ]
            }
          }
        },
        "required": [
          "success",
          "message",
          "issues"
        ]
      },
      "OneOffPaymentBank": {
        "type": "string",
        "enum": [
          "anz",
          "asb",
          "bnz",
          "kiwibank",
          "nzhl",
          "westpac",
          "demo_bank"
        ],
        "description": "The bank the customer must use to make this payment"
      },
      "Generic400ErrorResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              false
            ]
          },
          "message": {
            "type": "string"
          },
          "issues": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "$ref": "#/components/schemas/Generic400ErrorResponseCode"
                },
                "message": {
                  "type": "string"
                },
                "path": {
                  "$ref": "#/components/schemas/IssuePath"
                }
              },
              "required": [
                "code",
                "message",
                "path"
              ]
            }
          }
        },
        "required": [
          "success",
          "message",
          "issues"
        ]
      },
      "ConnectionId": {
        "type": "string",
        "pattern": "^conn_[a-z0-9]{25,27}$",
        "example": "conn_c01234567890123456789012345"
      },
      "OneOffPaymentLimitType": {
        "type": "string",
        "enum": [
          "single_payment",
          "daily",
          "weekly"
        ],
        "description": "The payment or time period that the limit applies to."
      },
      "PaymentLimitClassification": {
        "type": "string",
        "enum": [
          "strict",
          "informational"
        ],
        "description": "How the published value should be interpreted. A `strict` value is a fixed upper bound. An `informational` value is a default or indicative amount and the customer's actual limit may differ."
      },
      "OneOffPaymentLimit": {
        "type": "object",
        "properties": {
          "value": {
            "type": "number",
            "exclusiveMinimum": 0,
            "description": "The limit amount in dollars.",
            "example": 30000
          },
          "type": {
            "$ref": "#/components/schemas/OneOffPaymentLimitType"
          },
          "classification": {
            "$ref": "#/components/schemas/PaymentLimitClassification"
          },
          "description": {
            "type": "string",
            "description": "Additional context about how the limit is applied."
          }
        },
        "required": [
          "value",
          "type",
          "classification",
          "description"
        ]
      },
      "OneOffPaymentConnection": {
        "type": "object",
        "properties": {
          "_id": {
            "$ref": "#/components/schemas/ConnectionId"
          },
          "bank": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OneOffPaymentBank"
              },
              {
                "description": "The value to provide as payer.bank when creating a one-off payment.",
                "example": "westpac"
              }
            ]
          },
          "name": {
            "type": "string",
            "description": "The name of the institution.",
            "example": "Westpac"
          },
          "logo": {
            "type": "string",
            "format": "uri",
            "description": "A URL pointing to an image of the institution's logo."
          },
          "limits": {
            "type": "object",
            "properties": {
              "oneoff": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/OneOffPaymentLimit"
                }
              }
            },
            "required": [
              "oneoff"
            ]
          }
        },
        "required": [
          "_id",
          "bank",
          "name",
          "logo",
          "limits"
        ]
      },
      "OneOffPaymentConnectionsResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OneOffPaymentConnection"
            }
          }
        },
        "required": [
          "success",
          "items"
        ]
      }
    }
  },
  "paths": {
    "/v1/connections": {
      "get": {
        "operationId": "GetConnections",
        "tags": [
          "Connections"
        ],
        "summary": "Get available connections",
        "description": "Get the financial institution connections available to this application for one-off payments.",
        "deprecated": false,
        "security": [
          {
            "AppSecret": []
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OneOffPaymentConnectionsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Generic400ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Generic401ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Generic403ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  }
}
```