ds-ref-branches

ds-ref-branches 1.0.0

0
No votes yet
Branch

Latest Swagger specification for OpenData Branch Locator

forum Discuss this API in the forum
production
https://api.nedbank.co.za/apimarket/sandbox

Paths

/branches

get /branches
Branch

Gets a list of all Branch objects.

OAuth2Security
OAuth2Security
(oauth2 application)
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
tpp_client_credential
TPP Client Credential Scope
x-ibm-Client-Secret
X-IBM-Client-Secret
(apiKey located in header)
x-ibm-Client-Id
X-IBM-Client-Id
(apiKey located in header)
Authorization
Required in header
string

OAuth 2.0 based authorization header since a given date

offset
Optional in query
string

pagination header

Accept
Optional in header
string
application/json
cc314048
200

Successful response with a list of Branch data

{
    "schema": {
        "type": "object",
        "properties": {
            "Meta": {
                "title": "Meta data",
                "type": "object",
                "properties": {
                    "LastUpdated": {
                        "type": "string",
                        "format": "date-time"
                    },
                    "TotalResults": {
                        "type": "integer"
                    },
                    "Agreement": {
                        "type": "string",
                        "enum": [
                            "Use of the APIs and any related data will be subject to the terms of the Open Licence and subject to terms and conditions"
                        ]
                    },
                    "License": {
                        "description": "Open Banking License",
                        "type": "string",
                        "format": "uri",
                        "enum": [
                            "h
Show more open_in_new
400

You have sent a request which could not be understood.

{
    "schema": {
        "title": "400 Error object",
        "type": "object",
        "properties": {
            "status": {
                "type": "string",
                "enum": [
                    "400"
                ]
            },
            "title": {
                "type": "string",
                "enum": [
                    "Bad request"
                ]
            },
            "description": {
                "type": "string",
                "enum": [
                    "You have sent a request which could not be understood."
                ]
            }
        },
        "required": [
            "status",
            "title",
            "description"
        ],
        "additionalProperties": false
    }
}
408

Your client has failed to submit a request, and a timeout has occurred.

{
    "schema": {
        "title": "408 Error object",
        "type": "object",
        "properties": {
            "status": {
                "type": "string",
                "enum": [
                    "408"
                ]
            },
            "title": {
                "type": "string",
                "enum": [
                    "Client timeout"
                ]
            },
            "description": {
                "type": "string",
                "enum": [
                    "Your client has failed to submit a request, and a timeout has occurred."
                ]
            }
        },
        "required": [
            "status",
            "title",
            "description"
        ],
        "additionalProperties": false
    }
}
429

You have requested this resource too often. Slow down.

{
    "schema": {
        "title": "429 Error object",
        "type": "object",
        "properties": {
            "status": {
                "type": "string",
                "enum": [
                    "429"
                ]
            },
            "title": {
                "type": "string",
                "enum": [
                    "Too many requests"
                ]
            },
            "description": {
                "type": "string",
                "enum": [
                    "You have requested this resource too often. Slow down."
                ]
            }
        },
        "required": [
            "status",
            "title",
            "description"
        ],
        "additionalProperties": false
    }
}
500

An error occurred on the server. No further information is available.

{
    "schema": {
        "title": "500 Error object",
        "type": "object",
        "properties": {
            "status": {
                "type": "string",
                "enum": [
                    "500"
                ]
            },
            "title": {
                "type": "string",
                "enum": [
                    "Internal server error"
                ]
            },
            "description": {
                "type": "string",
                "enum": [
                    "An error occurred on the server. No further information is available."
                ]
            }
        },
        "required": [
            "status",
            "title",
            "description"
        ],
        "additionalProperties": false
    }
}
503

The service is temporarily unavailable.

{
    "schema": {
        "title": "503 Error object",
        "type": "object",
        "properties": {
            "status": {
                "type": "string",
                "enum": [
                    "503"
                ]
            },
            "title": {
                "type": "string",
                "enum": [
                    "Service temporarily unavailable"
                ]
            },
            "description": {
                "type": "string",
                "enum": [
                    "The service is temporarily unavailable."
                ]
            }
        },
        "required": [
            "status",
            "title",
            "description"
        ],
        "additionalProperties": false
    }
}
default

A standard error response.

{
    "schema": {
        "title": "Error object",
        "type": "object",
        "properties": {
            "status": {
                "description": "This corresponds to the HTTP status code",
                "type": "string"
            },
            "title": {
                "description": "A short title of the type of error",
                "type": "string"
            },
            "description": {
                "description": "Further details describing the error",
                "type": "string"
            }
        },
        "required": [
            "status",
            "title",
            "description"
        ],
        "additionalProperties": false
    }
}
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/v2/branches
Try this operation
https://api.nedbank.co.za/apimarket/sandbox/open-banking/v2/branches
accept
Authorization
offset

Definitions 

{
    "required": [
        "self"
    ],
    "properties": {
        "self": {
            "type": "string",
            "example": "http://localhost:3000/api/open-banking/v2/branches?offset=0"
        },
        "first": {
            "type": "string",
            "example": "http://localhost:3000/api/open-banking/v2/branches?offset=0"
        },
        "next": {
            "type": "string",
            "example": "http://localhost:3000/api/open-banking/v2/branches?offset=10"
        },
        "prev": {
            "type": "string",
            "example": "http://localhost:3000/api/open-banking/v2/branches?offset=0"
        }
    }
}