Functionality
This API allows you to start the process of originating a financial product as a third party platform. Therefore, the Santander customer will be able to start contracting from this third party. Also this API offers the possibility to ask for the status of a specific origination initiated by a third party platform using this API.
Security
This API is protected by OAuth token security. The associated OAuth flow is an Authorization Code.
Sandbox
This API is available in the Sandbox environment. In this environment, a non-real URL for initiate the hiring of financing products will be returned.
Paths
/
The API is protected by the authorization header. The TPP must indicate the access_token obtained by the during the consent process.
Product identifier for which the contract process will initiate
Url in which the contracting application will return the control to third party provider
Data for the contracting process
x265143
200 OK
/{operation_id}/status
The API is protected by the authorization header. The TPP must indicate the access_token obtained by the during the consent process.
Unique identifier of the hiring operation
x265143
200 OK
Definitions
{
"properties": {
"data": {
"type": "object",
"description": "Input data for origination process"
}
},
"additionalProperties": false,
"required": [
"data"
]
}
{
"properties": {
"status": {
"type": "string",
"description": "Indicates the sate of the contracting process",
"example": "ongoing"
},
"info": {
"type": "string",
"description": "Information message describing the status",
"example": "Hiring operation was successfully initiated"
},
"additionalInfo": {
"type": "string",
"description": "More information about the status",
"example": "Simulación"
}
},
"additionalProperties": false,
"required": [
"status"
]
}
{
"properties": {
"operation_id": {
"type": "string",
"description": "Unique identifier of the origination operation"
},
"status": {
"type": "string",
"description": "Indicates the sate of the origination process",
"example": "auth_required"
},
"redirect_uri": {
"type": "string",
"description": "Application url where the third party platform have to redirect the user in order to continue the origination process"
}
},
"additionalProperties": false,
"required": [
"operation_id"
]
}
List of custom errors
{
"type": "array",
"items": {
"$ref": "#\/definitions\/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"
]
}
