Credit Limit 1.0.0

Description

Functionality

This API allows accessing information about the financing products available to a Santander customer.

Security

This API is protected by OAuth Token security. The associated OAuth flow is an Authorization Code.

The scope allowed to consume this API is:

credit_limit.read: Generic scope which allows to get financing products information.

This scope should be requested in the Oauth Authorize API input (see OAuth Authorize API Documentation).

Output Example

This is an example of the output of this API with the list of financing products available for a Santander customer:

{
    &quot;HaveLimit&quot;: &quot;Y&quot;,
    &quot;products&quot;: [
        {
            &quot;product_id&quot;: &quot;1037450000007&quot;,
            &quot;limit_amount&quot;: 8000,
            &quot;limit_currency&quot;: &quot;EUR&quot;,
            &quot;product_name&quot;: &quot;Descuento de facturas&quot;
        },
        {
            &quot;product_id&quot;: &quot;1537450000002&quot;,
            &quot;limit_amount&quot;: 15000,
            &quot;limit_currency&quot;: &quot;EUR&quot;,
            &quot;product_name&quot;: &quot;Préstamos personal&quot;
        }
    ]
}

Endpoints

production

https://apis-sandbox.bancosantander.es/canales-digitales/sb

Paths

/

Security

clientIdHeader

X-IBM-Client-Id

(apiKey located in header)

This parameter is the ID that identifies the TPP that has been registered in the API Portal previously.

Parameters

Authorization

Required in header

string

The API is protected by the authorization header. The TPP must indicate the access_token obtained by the during the consent process.

Optional in header

string

application/json

Responses

200

200 OK

Example Request

Example Response

Definition

GET https://apis-sandbox.bancosantander.es/canales-digitales/sb/credit-limit/

Response

Try this operation

https://apis-sandbox.bancosantander.es/canales-digitales/sb/credit-limit/

Headers

Authorization

Request

Response

Definitions

creditLimitResponse

Object with information about the creadit products that a user is able to contract and it's limits.

{
    "properties": {
        "HaveLimit": {
            "type": "string",
            "example": "Y",
            "description": "Value that indicates if a client has or not any credit to contract. The allowed values are Y (Yes) and N (No)"
        },
        "products": {
            "$ref": "#/definitions/productList",
            "description": "List of products for a specified user"
        }
    },
    "additionalProperties": false
}

productList

List of products

{
    "type": "array",
    "items": {
        "$ref": "#/definitions/product"
    }
}

product

Information about a credit product.

{
    "properties": {
        "product_id": {
            "type": "string",
            "example": "14700370012375",
            "description": "Product identifier"
        },
        "product_name": {
            "type": "string",
            "description": "Product name",
            "example": "Préstamos"
        },
        "limit_amount": {
            "type": "number",
            "format": "double",
            "example": 10000,
            "description": "Maximum credit amount for a given user"
        },
        "limit_currency": {
            "type": "string",
            "example": "EUR",
            "description": "Currency of the limit amount value"
        }
    },
    "additionalProperties": false,
    "required": [
        "product_id",
        "product_name"
    ]
}

customErrorList

List of custom errors

{
    "type": "array",
    "items": {
        "$ref": "#/definitions/customError"
    }
}

customError

This object specifies the structure of the errors that can be given during the execution of the API.

{
    "properties": {
        "code": {
            "type": "string",
            "description": "Unique identifier for the error code.",
            "example": "GOIT_001"
        },
        "status": {
            "type": "string",
            "description": "HTTP Status of the error.",
            "example": "401"
        },
        "developerMessage": {
            "type": "string",
            "example": "ClientId in signature token differs from the ClientId associated to the access token",
            "description": "Message that is send to the developer."
        },
        "userMessage": {
            "type": "string",
            "description": "Message that is sent to the user.",
            "example": "The operation can not be reached."
        },
        "moreInfo": {
            "type": "string",
            "description": "More information related to the errors.",
            "example": "https://developer.bancosantander.es/api/errors/GOIT_001"
        }
    },
    "additionalProperties": false,
    "required": [
        "code",
        "userMessage",
        "moreInfo",
        "status",
        "developerMessage"
    ]
}