API OVERVIEW
API calls use the standard HTTP methods (GET, POST, PUT, DELETE) to perform operations on resources. Responses follow the hypermedia JSON format HAL.
REQUESTS AND RESPONSES
AUTHENTICATION
All requests are performed via HTTPS and use a JWT token in an Authorization header for each request.
Authorization: aa.bb.ccREQUEST FORMAT
The only supported content type is JSON.
Content-Type: application/jsonRESPONSE FORMAT
The response content type is HAL JSON.
Accept: application/hal+jsonERROR FORMAT
Errors will use the most appropriate HTTP status code contained in an API Problem response.
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616"
}ATOM feed ¶
ATOM feed ¶
ATOM feedGET/event-store/{fromEventId}/{toEventId}
Return all events from event store complaint agents
Example URI
GET https://payments.spotahome.com/event-store/0/100
URI Parameters
- fromEventId
number(required) Example: 0- toEventId
number(required) Example: 100
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"events": [
{
"id": "150",
"typeName": "com.sah.bounded_context.events.event_name",
"occurredOn": "2018-05-30T14:37:23+982300",
"eventBody": "{'id': '0179489b-88b1-493a-95bb-0dd497e78629', 'cic': '59', 'ric': '59', 'stage': 3}"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"events": {
"type": "array"
}
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Stream's ATOM feed ¶
Stream's ATOM feedGET/event-store/streams/{streamId}
Return all events from event store for a given stream
Example URI
GET https://payments.spotahome.com/event-store/streams/1b9ab58b-4f3c-445a-9843-daa90c137bba
URI Parameters
- streamId
string(required) Example: 1b9ab58b-4f3c-445a-9843-daa90c137bba
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"events": [
{
"id": "250",
"typeName": "com.sah.bounded_context.events.event_name",
"occurredOn": "2018-05-30T14:37:23+982300",
"eventBody": "{'id': '0179489b-88b1-493a-95bb-0dd497e78629', 'cic': '59', 'ric': '59', 'stage': 3}"
},
{
"id": "251",
"typeName": "com.sah.bounded_context.events.event_name",
"occurredOn": "2018-05-30T14:37:23+982300",
"eventBody": "{'id': '0179489b-88b1-493a-95bb-0dd497e78629', 'motive': '1'}"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"events": {
"type": "array"
}
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Payments ¶
View payment ¶
View paymentGET/payments/{id}
Example URI
GET https://payments.spotahome.com/payments/8f2dbe69-b68f-4423-bc93-b8b036727a032
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/hal+jsonBody
{
"id": "46a18a00-4e9b-463a-8aad-e4165efb4f92",
"isBlocked": true,
"updatedAt": "2018-02-09T15:13:42+0000"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"isBlocked": {
"type": "boolean"
},
"updatedAt": {
"type": "string"
}
}
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Block/Unblock payment ¶
Block paymentPUT/payments/{id}/block
Example URI
PUT https://payments.spotahome.com/payments/8f2dbe69-b68f-4423-bc93-b8b036727a032/block
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Unblock paymentDELETE/payments/{id}/block
Example URI
DELETE https://payments.spotahome.com/payments/8f2dbe69-b68f-4423-bc93-b8b036727a032/block
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Payment Methods ¶
Payment methodsGET/payments/payment-methods{?page,itemsPerPage}
Return all available payment methods
Example URI
GET https://payments.spotahome.com/payments/payment-methods?page=1&itemsPerPage=50
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 50
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 20,
"_links": {
"first": {
"href": "https://issues.spotahome.com/{resource}?page={pageNumber}"
},
"prev": {
"href": "https://issues.spotahome.com/{resource}?page={pageNumber}"
},
"next": {
"href": "https://issues.spotahome.com/{resource}?page={pageNumber}"
},
"last": {
"href": "https://issues.spotahome.com/{resource}?page={pageNumber}"
},
"self": {
"href": "https://issues.spotahome.com/{resource}?page={pageNumber}"
}
},
"_embedded": {
"payment-methods": [
{
"id": "1",
"text": "Braintree"
},
{
"id": "2",
"text": "Paypal"
},
{
"id": "3",
"text": "Bank transfer"
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "Number of listed items"
},
"total": {
"type": "number",
"description": "Total number of items"
},
"_links": {
"type": "object",
"properties": {
"first": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link URI or URI template"
}
},
"required": [
"href"
]
},
"prev": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link URI or URI template"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link URI or URI template"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link URI or URI template"
}
},
"required": [
"href"
]
},
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link URI or URI template"
}
},
"required": [
"href"
]
}
}
},
"_embedded": {
"type": "object",
"properties": {
"payment-methods": {
"type": "array"
}
}
}
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Bank Account Details ¶
Bank account details ¶
All Bank account details of auth user ¶
Fetch detailsGET/me/bank-account-details{?page,itemsPerPage}
Return all bank accounts associated to the authenticated user. Support pagination
Example URI
GET https://payments.spotahome.com/me/bank-account-details?page=1&itemsPerPage=50
URI Parameters
- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 50
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/hal+jsonBody
[
{
"id": "8aae4496-58c8-4ceb-9410-5c97d8856b02",
"useAsDefault": true,
"invoiceName": "John Doe",
"vatNumber": "DE11111",
"beneficiaryName": "John Doe",
"beneficiarySurname": "Doe",
"iban": "ES9704874526943884555359",
"bic": "BBVAESMMooo",
"city": "Madrid",
"zipCode": "28001",
"street": "Calle de Sta Engracia, 41-37",
"streetNumber": "41",
"floor": "1",
"door": "A",
"countryCode": "ES",
"businessType": "individual",
"tin": "123456789",
"tinCountry": "ES",
"registrationCountry": "ES",
"registrationDate": "2020-01-01"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Update bank account detailsPUT/me/bank-account-details
Example URI
PUT https://payments.spotahome.com/me/bank-account-details
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"useAsDefault": true,
"accountId": "c59295ab-c70e-421e-8018-a012a86e757c",
"invoiceName": "John Doe",
"vatNumber": "DE11111",
"beneficiaryName": "John Doe",
"beneficiarySurname": "Doe",
"iban": "ES9704874526943884555359",
"bic": "BBVAESMMooo",
"city": "Madrid",
"zipCode": "28001",
"street": "Calle de Sta Engracia, 41-37",
"streetNumber": "41",
"floor": "1",
"door": "A",
"countryCode": "ES",
"businessType": "individual",
"tin": "123456789",
"tinCountry": "ES",
"registrationCountry": "ES",
"registrationDate": "2020-01-01"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"accountId": {
"type": "string"
},
"useAsDefault": {
"type": "boolean",
"description": "Whether to use this account as the default."
},
"invoiceName": {
"type": [
"string",
"null"
],
"description": "Name to use for invoices."
},
"vatNumber": {
"type": [
"string",
"null"
],
"description": "VAT number associated with the account."
},
"beneficiaryName": {
"type": "string",
"description": "Name of the account beneficiary."
},
"beneficiarySurname": {
"type": [
"string",
"null"
],
"description": "Surname of the account beneficiary."
},
"iban": {
"type": "string",
"description": "IBAN of the account."
},
"bic": {
"type": [
"string",
"null"
],
"description": "BIC code of the bank."
},
"city": {
"type": [
"string",
"null"
],
"description": "City of the account holder's address."
},
"zipCode": {
"type": [
"string",
"null"
],
"description": "Postal code of the account holder's address."
},
"street": {
"type": [
"string",
"null"
],
"description": "Street of the account holder's address."
},
"streetNumber": {
"type": [
"string",
"null"
],
"description": "Street number of the address."
},
"floor": {
"type": [
"string",
"null"
],
"description": "Floor number of the address."
},
"door": {
"type": [
"string",
"null"
],
"description": "Door or apartment number of the address."
},
"countryCode": {
"type": [
"string",
"null"
],
"description": "Country code of the account holder's address."
},
"businessType": {
"type": [
"string",
"null"
],
"description": "Type of business associated with the account."
},
"tin": {
"type": [
"string",
"null"
],
"description": "Tax Identification Number."
},
"tinCountry": {
"type": [
"string",
"null"
],
"description": "Country issuing the TIN."
},
"registrationCountry": {
"type": [
"string",
"null"
],
"description": "Registration country of the business."
},
"registrationDate": {
"type": [
"string",
"null"
],
"description": "Date of business registration."
}
},
"required": [
"useAsDefault",
"accountId",
"useAsDefault",
"beneficiaryName",
"iban"
]
}Response
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Create bank account detailsPOST/me/bank-account-details
Example URI
POST https://payments.spotahome.com/me/bank-account-details
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"useAsDefault": true,
"invoiceName": "John Doe",
"vatNumber": "DE11111",
"beneficiaryName": "John Doe",
"beneficiarySurname": "Doe",
"iban": "ES9704874526943884555359",
"bic": "BBVAESMMooo",
"city": "Madrid",
"zipCode": "28001",
"street": "Calle de Sta Engracia, 41-37",
"streetNumber": "41",
"floor": "1",
"door": "A",
"countryCode": "ES",
"businessType": "individual",
"tin": "123456789",
"tinCountry": "ES",
"registrationCountry": "ES",
"registrationDate": "2020-01-01"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"useAsDefault": {
"type": "boolean",
"description": "Whether to use this account as the default."
},
"invoiceName": {
"type": [
"string",
"null"
],
"description": "Name to use for invoices."
},
"vatNumber": {
"type": [
"string",
"null"
],
"description": "VAT number associated with the account."
},
"beneficiaryName": {
"type": "string",
"description": "Name of the account beneficiary."
},
"beneficiarySurname": {
"type": [
"string",
"null"
],
"description": "Surname of the account beneficiary."
},
"iban": {
"type": "string",
"description": "IBAN of the account."
},
"bic": {
"type": [
"string",
"null"
],
"description": "BIC code of the bank."
},
"city": {
"type": [
"string",
"null"
],
"description": "City of the account holder's address."
},
"zipCode": {
"type": [
"string",
"null"
],
"description": "Postal code of the account holder's address."
},
"street": {
"type": [
"string",
"null"
],
"description": "Street of the account holder's address."
},
"streetNumber": {
"type": [
"string",
"null"
],
"description": "Street number of the address."
},
"floor": {
"type": [
"string",
"null"
],
"description": "Floor number of the address."
},
"door": {
"type": [
"string",
"null"
],
"description": "Door or apartment number of the address."
},
"countryCode": {
"type": [
"string",
"null"
],
"description": "Country code of the account holder's address."
},
"businessType": {
"type": [
"string",
"null"
],
"description": "Type of business associated with the account."
},
"tin": {
"type": [
"string",
"null"
],
"description": "Tax Identification Number."
},
"tinCountry": {
"type": [
"string",
"null"
],
"description": "Country issuing the TIN."
},
"registrationCountry": {
"type": [
"string",
"null"
],
"description": "Registration country of the business."
},
"registrationDate": {
"type": [
"string",
"null"
],
"description": "Date of business registration."
}
},
"required": [
"useAsDefault",
"beneficiaryName",
"iban"
]
}Response
201Headers
Location: /bank-account-details/aaaa-bbbb-cccc-ddddResponse
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Bank account details properties ¶
Fetch properties for one bank accountGET/me/bank-account-details/{id}/properties
Example URI
GET https://payments.spotahome.com/me/bank-account-details/8f2dbe69-b68f-4423-bc93-b8b036727a032/properties
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Body
{
"sah:propertyIds": [
"Hello, world!"
]
}Schema
{
"type": "object",
"properties": {
"sah:propertyIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Associate properties with bank accountPOST/me/bank-account-details/{id}/properties
Example URI
POST https://payments.spotahome.com/me/bank-account-details/8f2dbe69-b68f-4423-bc93-b8b036727a032/properties
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"propertyIds": [
"Hello, world!",
"Example"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"propertyIds": {
"type": "array",
"description": "List of property IDs."
}
},
"required": [
"propertyIds"
]
}Response
201Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/problem+jsonBody
{
"detail": "The access is forbidden",
"status": 403,
"title": "Forbidden Access",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Remove properties from bank accountDELETE/me/bank-account-details/{id}/properties
Example URI
DELETE https://payments.spotahome.com/me/bank-account-details/8f2dbe69-b68f-4423-bc93-b8b036727a032/properties
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"propertyIds": [
"Hello, world!",
"Example"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"propertyIds": {
"type": "array",
"description": "List of property IDs."
}
},
"required": [
"propertyIds"
]
}Response
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Bank account details properties ¶
Remove property from bank accountDELETE/me/bank-account-details/{id}/properties/{propertyId}
Example URI
DELETE https://payments.spotahome.com/me/bank-account-details/8f2dbe69-b68f-4423-bc93-b8b036727a032/properties/123456
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032- propertyId
string(required) Example: 123456
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Property bank account details ¶
Retrieve the bank account detail of a propertyGET/admin/landlords/{landlordId}/properties/{propertyId}/bank-account-detail
Example URI
GET https://payments.spotahome.com/admin/landlords/8f2dbe69-b68f-4423-bc93-b8b036727a032/properties/123456/bank-account-detail
URI Parameters
- landlordId
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032- propertyId
string(required) Example: 123456
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/hal+jsonBody
{
"id": "8aae4496-58c8-4ceb-9410-5c97d8856b02",
"useAsDefault": true,
"invoiceName": "John Doe",
"vatNumber": "DE11111",
"beneficiaryName": "John Doe",
"beneficiarySurname": "Doe",
"iban": "ES9704874526943884555359",
"bic": "BBVAESMMooo",
"city": "Madrid",
"zipCode": "28001",
"street": "Calle de Sta Engracia, 41-37",
"streetNumber": "41",
"floor": "1",
"door": "A",
"countryCode": "ES",
"businessType": "individual",
"tin": "123456789",
"tinCountry": "ES",
"registrationCountry": "ES",
"registrationDate": "2020-01-01"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"useAsDefault": {
"type": "boolean",
"description": "Whether to use this account as the default."
},
"invoiceName": {
"type": [
"string",
"null"
],
"description": "Name to use for invoices."
},
"vatNumber": {
"type": [
"string",
"null"
],
"description": "VAT number associated with the account."
},
"beneficiaryName": {
"type": "string",
"description": "Name of the account beneficiary."
},
"beneficiarySurname": {
"type": [
"string",
"null"
],
"description": "Surname of the account beneficiary."
},
"iban": {
"type": "string",
"description": "IBAN of the account."
},
"bic": {
"type": [
"string",
"null"
],
"description": "BIC code of the bank."
},
"city": {
"type": [
"string",
"null"
],
"description": "City of the account holder's address."
},
"zipCode": {
"type": [
"string",
"null"
],
"description": "Postal code of the account holder's address."
},
"street": {
"type": [
"string",
"null"
],
"description": "Street of the account holder's address."
},
"streetNumber": {
"type": [
"string",
"null"
],
"description": "Street number of the address."
},
"floor": {
"type": [
"string",
"null"
],
"description": "Floor number of the address."
},
"door": {
"type": [
"string",
"null"
],
"description": "Door or apartment number of the address."
},
"countryCode": {
"type": [
"string",
"null"
],
"description": "Country code of the account holder's address."
},
"businessType": {
"type": [
"string",
"null"
],
"description": "Type of business associated with the account."
},
"tin": {
"type": [
"string",
"null"
],
"description": "Tax Identification Number."
},
"tinCountry": {
"type": [
"string",
"null"
],
"description": "Country issuing the TIN."
},
"registrationCountry": {
"type": [
"string",
"null"
],
"description": "Registration country of the business."
},
"registrationDate": {
"type": [
"string",
"null"
],
"description": "Date of business registration."
}
},
"required": [
"useAsDefault",
"beneficiaryName",
"iban"
]
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Default Landlord bank account detail ¶
Retrieve the bank account detail of a propertyGET/admin/landlords/{landlordId}/bank-account-details/default
Example URI
GET https://payments.spotahome.com/admin/landlords/8f2dbe69-b68f-4423-bc93-b8b036727a032/bank-account-details/default
URI Parameters
- landlordId
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/hal+jsonBody
{
"id": "8aae4496-58c8-4ceb-9410-5c97d8856b02",
"useAsDefault": true,
"invoiceName": "John Doe",
"vatNumber": "DE11111",
"beneficiaryName": "John Doe",
"beneficiarySurname": "Doe",
"iban": "ES9704874526943884555359",
"bic": "BBVAESMMooo",
"city": "Madrid",
"zipCode": "28001",
"street": "Calle de Sta Engracia, 41-37",
"streetNumber": "41",
"floor": "1",
"door": "A",
"countryCode": "ES",
"businessType": "individual",
"tin": "123456789",
"tinCountry": "ES",
"registrationCountry": "ES",
"registrationDate": "2020-01-01"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"useAsDefault": {
"type": "boolean",
"description": "Whether to use this account as the default."
},
"invoiceName": {
"type": [
"string",
"null"
],
"description": "Name to use for invoices."
},
"vatNumber": {
"type": [
"string",
"null"
],
"description": "VAT number associated with the account."
},
"beneficiaryName": {
"type": "string",
"description": "Name of the account beneficiary."
},
"beneficiarySurname": {
"type": [
"string",
"null"
],
"description": "Surname of the account beneficiary."
},
"iban": {
"type": "string",
"description": "IBAN of the account."
},
"bic": {
"type": [
"string",
"null"
],
"description": "BIC code of the bank."
},
"city": {
"type": [
"string",
"null"
],
"description": "City of the account holder's address."
},
"zipCode": {
"type": [
"string",
"null"
],
"description": "Postal code of the account holder's address."
},
"street": {
"type": [
"string",
"null"
],
"description": "Street of the account holder's address."
},
"streetNumber": {
"type": [
"string",
"null"
],
"description": "Street number of the address."
},
"floor": {
"type": [
"string",
"null"
],
"description": "Floor number of the address."
},
"door": {
"type": [
"string",
"null"
],
"description": "Door or apartment number of the address."
},
"countryCode": {
"type": [
"string",
"null"
],
"description": "Country code of the account holder's address."
},
"businessType": {
"type": [
"string",
"null"
],
"description": "Type of business associated with the account."
},
"tin": {
"type": [
"string",
"null"
],
"description": "Tax Identification Number."
},
"tinCountry": {
"type": [
"string",
"null"
],
"description": "Country issuing the TIN."
},
"registrationCountry": {
"type": [
"string",
"null"
],
"description": "Registration country of the business."
},
"registrationDate": {
"type": [
"string",
"null"
],
"description": "Date of business registration."
}
},
"required": [
"useAsDefault",
"beneficiaryName",
"iban"
]
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Admin Bank account details ¶
Admin Create bank account detailsPOST/admin/bank-account-details
Example URI
POST https://payments.spotahome.com/admin/bank-account-details
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"useAsDefault": true,
"invoiceName": "John Doe",
"vatNumber": "DE11111",
"beneficiaryName": "John Doe",
"beneficiarySurname": "Doe",
"iban": "ES9704874526943884555359",
"bic": "BBVAESMMooo",
"city": "Madrid",
"zipCode": "28001",
"street": "Calle de Sta Engracia, 41-37",
"streetNumber": "41",
"floor": "1",
"door": "A",
"countryCode": "ES",
"businessType": "individual",
"tin": "123456789",
"tinCountry": "ES",
"registrationCountry": "ES",
"registrationDate": "2020-01-01"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"useAsDefault": {
"type": "boolean",
"description": "Whether to use this account as the default."
},
"invoiceName": {
"type": [
"string",
"null"
],
"description": "Name to use for invoices."
},
"vatNumber": {
"type": [
"string",
"null"
],
"description": "VAT number associated with the account."
},
"beneficiaryName": {
"type": "string",
"description": "Name of the account beneficiary."
},
"beneficiarySurname": {
"type": [
"string",
"null"
],
"description": "Surname of the account beneficiary."
},
"iban": {
"type": "string",
"description": "IBAN of the account."
},
"bic": {
"type": [
"string",
"null"
],
"description": "BIC code of the bank."
},
"city": {
"type": [
"string",
"null"
],
"description": "City of the account holder's address."
},
"zipCode": {
"type": [
"string",
"null"
],
"description": "Postal code of the account holder's address."
},
"street": {
"type": [
"string",
"null"
],
"description": "Street of the account holder's address."
},
"streetNumber": {
"type": [
"string",
"null"
],
"description": "Street number of the address."
},
"floor": {
"type": [
"string",
"null"
],
"description": "Floor number of the address."
},
"door": {
"type": [
"string",
"null"
],
"description": "Door or apartment number of the address."
},
"countryCode": {
"type": [
"string",
"null"
],
"description": "Country code of the account holder's address."
},
"businessType": {
"type": [
"string",
"null"
],
"description": "Type of business associated with the account."
},
"tin": {
"type": [
"string",
"null"
],
"description": "Tax Identification Number."
},
"tinCountry": {
"type": [
"string",
"null"
],
"description": "Country issuing the TIN."
},
"registrationCountry": {
"type": [
"string",
"null"
],
"description": "Registration country of the business."
},
"registrationDate": {
"type": [
"string",
"null"
],
"description": "Date of business registration."
}
},
"required": [
"useAsDefault",
"beneficiaryName",
"iban"
]
}Response
201Headers
Location: /bank-account-details/aaaa-bbbb-cccc-ddddResponse
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Admin Bank account details ¶
Fetch one bank account detailGET/admin/bank-account-details/{id}
Example URI
GET https://payments.spotahome.com/admin/bank-account-details/8f2dbe69-b68f-4423-bc93-b8b036727a032
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/hal+jsonBody
{
"id": "8aae4496-58c8-4ceb-9410-5c97d8856b02",
"useAsDefault": true,
"invoiceName": "John Doe",
"vatNumber": "DE11111",
"beneficiaryName": "John Doe",
"beneficiarySurname": "Doe",
"iban": "ES9704874526943884555359",
"bic": "BBVAESMMooo",
"city": "Madrid",
"zipCode": "28001",
"street": "Calle de Sta Engracia, 41-37",
"streetNumber": "41",
"floor": "1",
"door": "A",
"countryCode": "ES",
"businessType": "individual",
"tin": "123456789",
"tinCountry": "ES",
"registrationCountry": "ES",
"registrationDate": "2020-01-01"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"useAsDefault": {
"type": "boolean",
"description": "Whether to use this account as the default."
},
"invoiceName": {
"type": [
"string",
"null"
],
"description": "Name to use for invoices."
},
"vatNumber": {
"type": [
"string",
"null"
],
"description": "VAT number associated with the account."
},
"beneficiaryName": {
"type": "string",
"description": "Name of the account beneficiary."
},
"beneficiarySurname": {
"type": [
"string",
"null"
],
"description": "Surname of the account beneficiary."
},
"iban": {
"type": "string",
"description": "IBAN of the account."
},
"bic": {
"type": [
"string",
"null"
],
"description": "BIC code of the bank."
},
"city": {
"type": [
"string",
"null"
],
"description": "City of the account holder's address."
},
"zipCode": {
"type": [
"string",
"null"
],
"description": "Postal code of the account holder's address."
},
"street": {
"type": [
"string",
"null"
],
"description": "Street of the account holder's address."
},
"streetNumber": {
"type": [
"string",
"null"
],
"description": "Street number of the address."
},
"floor": {
"type": [
"string",
"null"
],
"description": "Floor number of the address."
},
"door": {
"type": [
"string",
"null"
],
"description": "Door or apartment number of the address."
},
"countryCode": {
"type": [
"string",
"null"
],
"description": "Country code of the account holder's address."
},
"businessType": {
"type": [
"string",
"null"
],
"description": "Type of business associated with the account."
},
"tin": {
"type": [
"string",
"null"
],
"description": "Tax Identification Number."
},
"tinCountry": {
"type": [
"string",
"null"
],
"description": "Country issuing the TIN."
},
"registrationCountry": {
"type": [
"string",
"null"
],
"description": "Registration country of the business."
},
"registrationDate": {
"type": [
"string",
"null"
],
"description": "Date of business registration."
}
},
"required": [
"useAsDefault",
"beneficiaryName",
"iban"
]
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Admin Update bank account detailsPUT/admin/bank-account-details/{id}
Example URI
PUT https://payments.spotahome.com/admin/bank-account-details/8f2dbe69-b68f-4423-bc93-b8b036727a032
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"useAsDefault": true,
"invoiceName": "John Doe",
"vatNumber": "DE11111",
"beneficiaryName": "John Doe",
"beneficiarySurname": "Doe",
"iban": "ES9704874526943884555359",
"bic": "BBVAESMMooo",
"city": "Madrid",
"zipCode": "28001",
"street": "Calle de Sta Engracia, 41-37",
"streetNumber": "41",
"floor": "1",
"door": "A",
"countryCode": "ES",
"businessType": "individual",
"tin": "123456789",
"tinCountry": "ES",
"registrationCountry": "ES",
"registrationDate": "2020-01-01"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"useAsDefault": {
"type": "boolean",
"description": "Whether to use this account as the default."
},
"invoiceName": {
"type": [
"string",
"null"
],
"description": "Name to use for invoices."
},
"vatNumber": {
"type": [
"string",
"null"
],
"description": "VAT number associated with the account."
},
"beneficiaryName": {
"type": "string",
"description": "Name of the account beneficiary."
},
"beneficiarySurname": {
"type": [
"string",
"null"
],
"description": "Surname of the account beneficiary."
},
"iban": {
"type": "string",
"description": "IBAN of the account."
},
"bic": {
"type": [
"string",
"null"
],
"description": "BIC code of the bank."
},
"city": {
"type": [
"string",
"null"
],
"description": "City of the account holder's address."
},
"zipCode": {
"type": [
"string",
"null"
],
"description": "Postal code of the account holder's address."
},
"street": {
"type": [
"string",
"null"
],
"description": "Street of the account holder's address."
},
"streetNumber": {
"type": [
"string",
"null"
],
"description": "Street number of the address."
},
"floor": {
"type": [
"string",
"null"
],
"description": "Floor number of the address."
},
"door": {
"type": [
"string",
"null"
],
"description": "Door or apartment number of the address."
},
"countryCode": {
"type": [
"string",
"null"
],
"description": "Country code of the account holder's address."
},
"businessType": {
"type": [
"string",
"null"
],
"description": "Type of business associated with the account."
},
"tin": {
"type": [
"string",
"null"
],
"description": "Tax Identification Number."
},
"tinCountry": {
"type": [
"string",
"null"
],
"description": "Country issuing the TIN."
},
"registrationCountry": {
"type": [
"string",
"null"
],
"description": "Registration country of the business."
},
"registrationDate": {
"type": [
"string",
"null"
],
"description": "Date of business registration."
}
},
"required": [
"useAsDefault",
"beneficiaryName",
"iban"
]
}Response
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/problem+jsonBody
{
"detail": "The access is forbidden",
"status": 403,
"title": "Forbidden Access",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Admin Bank account details match properties ¶
Admin create match bank account details and propertiesPOST/admin/bank-account-details/{id}/properties
Example URI
POST https://payments.spotahome.com/admin/bank-account-details/8f2dbe69-b68f-4423-bc93-b8b036727a032/properties
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"propertyIds": [
"Example"
]
}Response
201Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/problem+jsonBody
{
"detail": "The access is forbidden",
"status": 403,
"title": "Forbidden Access",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Admin Bank Account Detail PropertiesGET/admin/bank-account-details/{id}/properties
Retrieve the list of propertyIds associated with a specific bank account detail.
Example URI
GET https://payments.spotahome.com/admin/bank-account-details/8f2dbe69-b68f-4423-bc93-b8b036727a032/properties
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"propertyIds": [
"Hello, world!",
"67882",
"99721",
"12345"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"propertyIds": {
"type": "array",
"description": "List of associated property IDs."
}
}
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/problem+jsonBody
{
"detail": "The access is forbidden",
"status": 403,
"title": "Forbidden Access",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Admin remove match bank account details and propertiesDELETE/admin/bank-account-details/{id}/properties
Example URI
DELETE https://payments.spotahome.com/admin/bank-account-details/8f2dbe69-b68f-4423-bc93-b8b036727a032/properties
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"propertyIds": [
"Example"
]
}Response
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/problem+jsonBody
{
"detail": "The access is forbidden",
"status": 403,
"title": "Forbidden Access",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Tin validate ¶
Validate TINPOST/tin/validate
Example URI
POST https://payments.spotahome.com/tin/validate
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"tin": "27484819A",
"tinCountry": "ES",
"businessType": "individual"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"tin": {
"type": [
"string",
"null"
]
},
"tinCountry": {
"type": [
"string",
"null"
]
},
"businessType": {
"type": "string"
}
},
"required": [
"businessType"
]
}Response
200Body
{
"isValid": true
}Schema
{
"type": "object",
"properties": {
"isValid": {
"type": "boolean"
}
},
"required": [
"isValid"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/problem+jsonBody
{
"detail": "The access is forbidden",
"status": 403,
"title": "Forbidden Access",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Payments Domain Events ¶
PaymentWasBlocked
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentWasBlocked",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id" : "8f2dbe69-b68f-4423-bc93-b8b036727a032"
}
}PaymentWasUnblocked
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentWasUnblocked",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id" : "8f2dbe69-b68f-4423-bc93-b8b036727a032",
}
}PaymentWasCreated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentWasCreated",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032"
"sourceId" : "8f2dbe69-b68f-4423-bc93-b8b036727a032",
"sourceType": "COMPLAINTS",
"amount": 2000,
"paymentMethod": "credit_card",
"isManual": true,
"concept": "adjustment-tenantFee"
}
}PaymentCreated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentCreated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032"
"sourceType": "BOOKING",
"sourceId": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"sourceRefCode": "12345-1D",
"referencePaymentId": "b8b036727a032-b68f-4423-bc93-b8b03672",
"originPaymentHolderId": "4423be69-b68f-4423-bc93-b8b036727a032",
"originPaymentMethodId": "abc93e69-b68f-4423-bc93-b8b036727a032",
"type": "FEE",
"amount": 12345,
"currencyCode": "EUR",
"reference": "spotahome-fee",
"isAutomatic": false,
"dueDate": "2019-10-10",
"status": "created",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentCanceled
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentCanceled",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032"
"status": "canceled",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentFailed
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentFailed",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032"
"transactionId": "Iughag1e",
"status": "failed",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentPaid
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentPaid",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032"
"status": "paid",
"paidDate": "2019-10-10 12:00:00",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentStarted
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentStarted",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"transactionId": "1AB23456C7890123D",
"status": "InProgress",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentValidated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentValidated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"status": "Ready",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentValidationFailed
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentValidationFailed",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"status": "ValidationFailed",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderCreated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHolderCreated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"userId": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"name": "Holder name",
"email": "holder@email.com",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderMethodCreated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHolderMethodCreated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"paymentHolderId": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"type": "paypal",
"token": "much1yoo0aNg1yu",
"provider": "braintree",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderMethodSetAsDefault
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHolderMethodSetAsDefault",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"paymentHolderMethodId": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHoldersUpdatedForPayment
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHoldersUpdatedForPayment",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"originPaymentHolderId": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"originPaymentMethodId": "acb-b68f-4423-bc93-b8b036727a032",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}OriginPaymentHolderMethodUpdated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\OriginPaymentHolderMethodUpdated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"originPaymentMethodId": "acb-b68f-4423-bc93-b8b036727a032",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentOriginPaymentMethodUpdated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentOriginPaymentMethodUpdated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"originPaymentMethodId": "acb-b68f-4423-bc93-b8b036727a032",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderEmailUpdated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHolderEmailUpdated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"email": "holder@email.com",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderShareHolderCreated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHolderShareHolderCreated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"paymentMethodId": "acb-b68f-4423-bc93-b8b036727a032",
"countryCode": "ES",
"city": "Madrid",
"postalCode": "28001",
"addressLine1": "Street address line 1",
"addressLine2": "",
"houseNumber": "12",
"dateOfBirth": "2000-09-03",
"gender": "Male",
"name": "John",
"lastName": "Doe",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderShareHolderUpdated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHolderShareHolderUpdated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"paymentMethodId": "acb-b68f-4423-bc93-b8b036727a032",
"countryCode": "ES",
"city": "Madrid",
"postalCode": "28001",
"addressLine1": "Street address line 1",
"addressLine2": "",
"houseNumber": "12",
"dateOfBirth": "2000-09-03",
"gender": "Male",
"name": "John",
"lastName": "Doe",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderIdentityVerificationStatusUpdated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHolder\PaymentHolderIdentityVerificationStatusUpdated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"status": "UNCHECKED",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderPassportVerificationStatusUpdated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHolder\PaymentHolderPassportVerificationStatusUpdated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"status": "UNCHECKED",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderNameUpdated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHolderNameUpdated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"name": "John Doe",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderShareholderMarkedAsNotCreatedInProvider
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHolderShareholderMarkedAsNotCreatedInProvider",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderShareholderMarkedAsNotUpdatedInProvider
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentHolderShareholderMarkedAsNotUpdatedInProvider",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"errors": ["error-1", "error-2"],
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentHolderKycDataRequired
{
"id": 1,
"typeName": "Sah\Payments\Domain\Events\PaymentHolder\PaymentHolderKycDataRequired",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody": {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"userId": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"email": "landlord@mail.com",
"formUrl": "https://link-to-form.com",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}PaymentWasManuallyPaid
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\PaymentManuallyPaid",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032"
"status": "Paid",
"version": 1,
"metadata": {
"occurredOn": {
"date": "2018-08-02T16:09:54.000Z",
"timezone": "UTC",
"timezone_type": 3
}
}
}
}BankAccountDetailWasCreated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\Billing\BankAccountDetailWasCreated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"useAsDefault": true,
"accountId": "c59295ab-c70e-421e-8018-a012a86e757c",
"invoiceName": "Invoce name",
"vatNumber": "DE11111",
"beneficiaryName": "John Doe",
"iban": "ES9704874526943884555359",
"bic": "BBVAESMMooo",
"city": "madrid",
"zipCode": "28001",
"street": "Calle de Sta Engracia, 41-37",
"countryCode": "ES",
"occurredOn": "2018-08-02T16:09:54.000Z"
}
}BankAccountDetailWasUpdated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\Billing\BankAccountDetailWasUpdated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"useAsDefault": true,
"invoiceName": "Invoce name",
"vatNumber": "DE11111",
"beneficiaryName": "John Doe",
"iban": "ES9704874526943884555359",
"previousIban": "ES9704874526943884555359",
"bic": "BBVAESMMooo",
"city": "madrid",
"zipCode": "28001",
"street": "Calle de Sta Engracia, 41-37",
"countryCode": "ES",
"occurredOn": "2018-08-02T16:09:54.000Z"
}
}BankAccountDetailWasObfuscated
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\Billing\BankAccountDetailWasObfuscated",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"occurredOn": "2018-08-02T16:09:54.000Z"
}
}BankAccountDetailWasMarkedAsNoDefault
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\Billing\BankAccountDetailWasMarkedAsNoDefault",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"id": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"occurredOn": "2018-08-02T16:09:54.000Z"
}
}BankAccountDetailWasMatchedWithProperty
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\Billing\BankAccountDetailWasMatchedWithProperty",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"bankAccountDetailId": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"propertyId": "453452",
"occurredOn": "2018-08-02T16:09:54.000Z"
}
}BankAccountDetailWasUnmatchedWithProperty
{
"id" : 1,
"typeName" : "Sah\Payments\Domain\Events\Billing\BankAccountDetailWasUnmatchedWithProperty",
"occurredOn": "2018-08-02T16:09:54.000Z",
"eventBody" : {
"bankAccountDetailId": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"propertyId": "453452",
"occurredOn": "2018-08-02T16:09:54.000Z"
}
}Installments Domain Events ¶
InstallmentItemAmountWasChanged
{
"id" : 1,
"typeName" : "com.sah.payments.events.installment_item_amount_was_changed",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "018e1a73-4a25-7290-892f-7e4f9c6efda8",
"amount": 2000,
"occurredOn": "2024-03-08T11:54:53+00:00",
"installmentId": "018e1a73-4a24-7170-9dba-565a63d1ff3d"
}
}InstallmentItemWasAdded
{
"id" : 1,
"typeName" : "com.sah.payments.events.installment_item_was_added",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "018e13b9-271c-726b-bfe0-6152bb6b552a",
"type": "rent",
"amount": 0,
"createdAt": "2024-03-06T12:24:45+00:00",
"occurredOn": "2024-03-06T12:24:45+00:00",
"description": null,
"installmentId": "018e13b9-26b9-704b-8c92-b3839e11042c"
}
}InstallmentItemWasDeleted
{
"id" : 1,
"typeName" : "com.sah.payments.events.installment_item_was_deleted",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "018e190e-b244-718d-b3ec-25a61ef78820",
"occurredOn": "2024-03-08T08:13:35+00:00",
"installmentId": "018e190e-b242-7138-8b7b-e4037f5e8fa0"
}
}InstallmentItemWasUpdated
{
"id" : 1,
"typeName" : "com.sah.payments.events.installment_item_was_updated",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "018f527d-dc99-7343-a5fc-32eaacc40d0e",
"type": "adjustment",
"amount": -5000,
"updatedAt": "2024-05-07T12:47:37+00:00",
"occurredOn": "2024-05-07T12:47:37+00:00",
"description": "Tenant adjustmnet",
"installmentId": "0186c753-5a3a-73ad-b3ea-e13901c8678c"
}
}InstallmentDueDateWasChanged
{
"id" : 1,
"typeName" : "com.sah.payments.events.installment_due_date_was_changed",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id" : "8f2dbe69-b68f-4423-bc93-b8b036727a032",
"dueDate" : "2023-10-03",
"occurredOn" : "2017-05-18T09:55:06.000Z"
}
}InstallmentPeriodWasChanged
{
"id" : 1,
"typeName" : "com.sah.payments.events.installment_period_was_changed",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "018e1a73-4a24-7170-9dba-565a63d1ff3d",
"periodTo": "2024-04-19",
"occurredOn": "2024-03-08T11:54:53+00:00",
"periodFrom": "2024-04-01"
}
}InstallmentUserWasChanged
{
"id" : 1,
"typeName" : "com.sah.payments.events.installment_user_was_changed",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "0189b1f8-7730-7160-ade5-c7f6c019dfc6",
"userId": "71c4b901-c6d7-4452-9da7-5542efb4dbc0",
"actionedBy": "47295c2c-803c-4a88-a6f7-12ec5ebf3f9e",
"occurredOn": "2024-06-03T14:43:59+00:00"
}
}InstallmentWasCreated
{
"id" : 1,
"typeName" : "com.sah.payments.events.installment_was_created",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "018e13b9-26b9-704b-8c92-b3839e11042c",
"type": "payin",
"state": "tobereviewed",
"userId": "a986cedd-74ec-415c-a921-b8ab18282ad1",
"dueDate": "2024-07-01",
"refCode": "G5K956-GX-IML",
"periodTo": "2024-07-31",
"sourceId": "a5406557-a774-4d48-960d-a6b698a3e529",
"createdAt": "2024-03-06T12:24:45+00:00",
"occurredOn": "2024-03-06T12:24:45+00:00",
"periodFrom": "2024-07-01",
"sourceType": "booking",
"currencyCode": "EUR"
}
}InstallmentWasDeleted
{
"id" : 1,
"typeName" : "com.sah.payments.events.installment_was_deleted",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "018e190e-b242-7138-8b7b-e4037f5e8fa0",
"occurredOn": "2024-03-08T08:13:35+00:00"
}
}InstallmentWasReviewed
{
"id" : 1,
"typeName" : "com.sah.payments.events.installment_was_reviewed",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "0180d6d1-3ed8-71f1-b89a-19778e7dab39",
"state": "reviewed",
"actionedBy": "d62324b9-3f33-42b2-8ba7-9cdd2a1d30da",
"occurredOn": "2024-04-19T11:04:32+00:00"
}
}Transactions Domain Events ¶
TransactionAmountReceivedWasRefunded
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_amount_received_was_refunded",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "0c1996c9-9597-4a22-ae5d-2739d06c0ce6",
"actionedBy": "consumer queue refund_transaction_on_stripe_charge_refunded",
"occurredOn": "2024-06-04T07:22:45+00:00",
"amountReceived": 0,
"amountRefunded": 21700
}
}TransactionAmountReceivedWasUpdated
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_amount_received_was_updated",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "c573ee47-c5b5-422e-80a6-0992e2918987",
"actionedBy": "consumer queue pay_transaction_on_stripe_payment_intent_was_updated",
"occurredOn": "2024-05-29T10:26:56+00:00",
"amountReceived": 40
}
}TransactionWasCanceled
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_was_canceled",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "f90c79fa-d9cc-48cf-a0ab-7a6ce2f776f4",
"state": "canceled",
"actionedBy": "console command cancel:transaction",
"occurredOn": "2024-05-31T12:23:05+00:00",
"cancellationReason": "Executed manually from CancelTransactionConsoleCommand"
}
}TransactionWasCreated
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_was_created",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "d48f6ac0-ce82-438b-8bff-4e495daf3e36",
"state": "pending",
"amount": 59488,
"provider": "stripe",
"actionedBy": "console command generate:transactions:from_installments",
"occurredOn": "2024-05-23T21:00:10+00:00",
"installmentId": "0189c22a-e778-7120-9d1e-5560c182833f",
"paymentMethod": "card",
"amountReceived": 0,
"originalTransactionId": null,
"executionAttempt": 1
}
}TransactionWasDeleted
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_was_deleted",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "d48f6ac0-ce82-438b-8bff-4e495daf3e36",
"installmentId": "403ef46c-c8ce-40a9-97c9-f2135c3c2fb6",
"actionedBy": "consumer queue sync_transactions_on_installment_events",
"occurredOn": "2024-05-24T08:59:03+00:00"
}
}TransactionWasExecuted
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_was_executed",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "403ef46c-c8ce-40a9-97c9-f2135c3c2fb6",
"state": "executed",
"result": {"isSuccessful": true},
"actionedBy": "consumer queue execute_transaction_on_transaction_was_initiated",
"executedAt": "2024-05-24T14:21:10+00:00",
"occurredOn": "2024-05-24T14:21:10+00:00",
"providerTransactionId": "pi_3PJyzVIzcid8RrBH0o2sbLs5",
"providerTransactionType": "payment_intent"
}
}TransactionWasExecuting
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_was_executing",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "403ef46c-c8ce-40a9-97c9-f2135c3c2fb6",
"state": "executing",
"actionedBy": "consumer queue execute_transaction_on_transaction_was_initiated",
"occurredOn": "2024-05-24T14:21:03+00:00"
}
}TransactionWasFailed
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_was_failed",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "bd3b2457-b1d0-4ece-80ce-026ec7a7bc82",
"state": "failed",
"result": [],
"actionedBy": "consumer queue fail_transaction_on_payment_intent_was_failed",
"occurredOn": "2024-05-24T14:20:17+00:00",
"failureType": "dispute_lost",
"failureReason": "fraudulent"
}
}TransactionWasImported
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_was_imported",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "cf83e818-b99a-4174-8f36-3c164eda0c2b",
"state": "paid",
"amount": 103554,
"paidAt": "2024-05-20T07:22:00+00:00",
"result": {"isSuccessful": true},
"provider": "stripe",
"actionedBy": "console command transaction:import:from_spreadsheet",
"executedAt": "2024-05-06T14:39:00+00:00",
"occurredOn": "2024-05-23T10:21:35+00:00",
"executionDate": "2024-05-06",
"installmentId": "018c658e-d4fd-7250-9f5b-3f2739b0944b",
"paymentMethod": "bank_transfer",
"amountReceived": 103554,
"providerTransactionId": "pi_3PDShVIzcid8RrBH0okv0bEO",
"providerTransactionType": "payment_intent"
}
}TransactionWasInitiated
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_was_initiated",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "403ef46c-c8ce-40a9-97c9-f2135c3c2fb6",
"state": "initiated",
"actionedBy": "consumer queue retry_transaction_on_failure",
"occurredOn": "2024-05-24T14:20:43+00:00"
}
}TransactionWasPaid
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_was_paid",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "81368ae6-13c9-4da7-913a-501e00ae00b6",
"state": "paid",
"paidAt": "2024-05-30T00:00:00+00:00",
"actionedBy": "consumer queue pay_transaction_on_stripe_payout_was_paid",
"occurredOn": "2024-05-30T01:23:41+00:00"
}
}TransactionWasUpdatedFromImport
{
"id" : 1,
"typeName" : "com.sah.payments.events.transaction_was_updated_from_import",
"occurredOn" : "2017-05-18T09:55:06.000Z",
"eventBody" : {
"id": "14206442-b2a2-49fc-b0e0-da300d6c01c3",
"amount": 160000,
"provider": "stripe",
"actionedBy": "console command transaction:import:from_spreadsheet",
"executedAt": "2024-05-20T13:12:00+00:00",
"occurredOn": "2024-06-03T13:26:30+00:00",
"executionDate": "2024-05-20",
"installmentId": "018d5a09-f310-7338-9bc4-5e7f7a482c6a",
"paymentMethod": "bank_transfer",
"providerTransactionId": "pi_3PIW0dIzcid8RrBH0Wt8pUwO",
"providerTransactionType": "payment_intent"
}
}Stripe ¶
Stripe Account ¶
Stripe landlord accountGET/stripe/accounts/{landlordId}
Example URI
GET https://payments.spotahome.com/stripe/accounts/8f2dbe69-b68f-4423-bc93-b8b036727a032
URI Parameters
- landlordId
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/hal+jsonBody
{
"landlordId": "8aae4496-58c8-4ceb-9410-5c97d8856b02",
"accountId": "8aae4496-58c8-4ceb-9410-5c97d8856b02",
"status": "Enabled"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"landlordId": {
"type": "string"
},
"accountId": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"Enabled",
"Restricted",
"RestrictedSoon",
"Other"
]
}
},
"required": [
"status"
]
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Stripe KYC ¶
Generate KYC linkPOST/stripe/accounts/me/kyc-link
Example URI
POST https://payments.spotahome.com/stripe/accounts/me/kyc-link
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/hal+jsonBody
{
"url": "https://connect.stripe.com/setup/e/acct_1MiclvIojP6YdaP5"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}Response
400Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
403Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Stripe Payment Intents ¶
Create payment intentPOST/stripe/payment-intents
-
Request
-
Headers
Content-Type: application/json Authorization: aa.bb.cc
-
Example URI
POST https://payments.spotahome.com/stripe/payment-intents
Response
201Headers
Content-Type: application/hal+jsonResponse
400Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Big Rock Rent Collection - Abandoned ¶
Admin view payment ¶
View paymentGET/admin/payments/{id}
Example URI
GET https://payments.spotahome.com/admin/payments/8f2dbe69-b68f-4423-bc93-b8b036727a032
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/hal+jsonBody
{
"id": "46a18a00-4e9b-463a-8aad-e4165efb4f92",
"sourceType": "booking",
"sourceId": "c7e77276-b445-11e9-b63f-f797e2bd17aa",
"sourceRefCode": "12345-3A",
"referencePaymentId": "`c7e7746a",
"originPaymentHolderId": "ec808186-b445-11e9-8da7-b39638fa8eec",
"originPaymentMethodId": "f8b91b3e-b445-11e9-aef0-2bfeb95a91fd",
"targetPaymentHolderId": "f279ec44-b445-11e9-b6d5-d3e116575733",
"targetPaymentMethodId": "fceb21f2-b445-11e9-864e-6395bf16554f",
"isAutomatic": true,
"status": "CREATED",
"dueDate": "2022-09-29",
"paidDate": "2022-09-29",
"transactionId": "Eax2feop"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sourceType": {
"type": "string"
},
"sourceId": {
"type": "string"
},
"sourceRefCode": {
"type": [
"string",
"null"
]
},
"referencePaymentId": {
"type": "string",
"description": "b445-11e9-b642-a7b31af74b9d (string, nullable),"
},
"originPaymentHolderId": {
"type": "string"
},
"originPaymentMethodId": {
"type": "string"
},
"targetPaymentHolderId": {
"type": "string"
},
"targetPaymentMethodId": {
"type": "string"
},
"isAutomatic": {
"type": "boolean"
},
"status": {
"type": "string"
},
"dueDate": {
"type": "string"
},
"paidDate": {
"type": [
"string",
"null"
]
},
"transactionId": {
"type": [
"string",
"null"
]
}
}
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Public view payment ¶
View paymentGET/public/payments/{id}
Example URI
GET https://payments.spotahome.com/public/payments/8f2dbe69-b68f-4423-bc93-b8b036727a032
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/hal+jsonBody
{
"id": "46a18a00-4e9b-463a-8aad-e4165efb4f92",
"type": "fee-collection",
"amount": "22345",
"currencyCode": "EUR",
"reference": "spotahome fee",
"status": "CREATED",
"dueDate": "2022-09-29"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"amount": {
"type": "string"
},
"currencyCode": {
"type": "string"
},
"reference": {
"type": "string"
},
"status": {
"type": "string"
},
"dueDate": {
"type": "string"
}
}
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Tenant Payments ¶
Tenant paymentsGET/payments{?bookingId,sourceId,type,userId,sourceRefCode,page,itemsPerPage,sortBy,sortType}
Return tenant payments for a booking id and a type
Example URI
GET https://payments.spotahome.com/payments?bookingId=cbbf054a-1ab6-4d2a-89c0-8adf1c03cb19&sourceId=cbbf054a-1ab6-4d2a-89c0-8adf1c03cb19&type=fee-collection&userId=cbbf054a-1ab6-4d2a-89c0-8adf1c03cb19&sourceRefCode=ST24DC-9FZ&page=1&itemsPerPage=50&sortBy=dueDate&sortType=ASC
URI Parameters
- bookingId
string(optional) Example: cbbf054a-1ab6-4d2a-89c0-8adf1c03cb19- sourceId
string(optional) Example: cbbf054a-1ab6-4d2a-89c0-8adf1c03cb19- userId
string(optional) Example: cbbf054a-1ab6-4d2a-89c0-8adf1c03cb19- sourceRefCode
string(optional) Example: ST24DC-9FZ- type
string(optional) Example: fee-collection- page
number(optional) Example: 1- itemsPerPage
number(optional) Example: 50- sortBy
string(optional) Example: dueDate- sortType
string(optional) Example: ASC
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/jsonBody
{
"count": 1,
"total": 20,
"_links": {
"first": {
"href": "https://issues.spotahome.com/{resource}?page={pageNumber}"
},
"prev": {
"href": "https://issues.spotahome.com/{resource}?page={pageNumber}"
},
"next": {
"href": "https://issues.spotahome.com/{resource}?page={pageNumber}"
},
"last": {
"href": "https://issues.spotahome.com/{resource}?page={pageNumber}"
},
"self": {
"href": "https://issues.spotahome.com/{resource}?page={pageNumber}"
}
},
"_embedded": {
"tenant-payments": [
{
"id": "1",
"dueDate": "2022-09-29",
"amount": 7899,
"currencyCode": "EUR",
"status": "Ready",
"type": "rent-collection",
"reason": "Rejected",
"sourceType": "booking",
"sourceId": "eeeef468-52f4-4995-abc7-25f0f6076b0b",
"sourceRefCode": "R4KDP5-E7",
"isAutomatic": true
},
{
"id": "1",
"dueDate": "2022-09-29",
"amount": 7899,
"currencyCode": "EUR",
"status": "Ready",
"type": "rent-collection",
"reason": "Rejected",
"sourceType": "booking",
"sourceId": "eeeef468-52f4-4995-abc7-25f0f6076b0b",
"sourceRefCode": "R4KDP5-E7",
"isAutomatic": true
}
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"count": {
"type": "number",
"description": "Number of listed items"
},
"total": {
"type": "number",
"description": "Total number of items"
},
"_links": {
"type": "object",
"properties": {
"first": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link URI or URI template"
}
},
"required": [
"href"
]
},
"prev": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link URI or URI template"
}
},
"required": [
"href"
]
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link URI or URI template"
}
},
"required": [
"href"
]
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link URI or URI template"
}
},
"required": [
"href"
]
},
"self": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The link URI or URI template"
}
},
"required": [
"href"
]
}
}
},
"_embedded": {
"type": "object",
"properties": {
"tenant-payments": {
"type": "array"
}
}
}
}
}Response
401Headers
Content-Type: application/jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Create payment ¶
Create paymentPOST/payments
Example URI
POST https://payments.spotahome.com/payments
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"sourceId": "8f2dbe69-b68f-4423-bc93-b8b036727a032",
"sourceType": "COMPLAINT",
"amount": 2000,
"paymentMethod": "1",
"paymentType": "charge",
"isManual": true,
"concept": "adjustment-tenantFee"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"sourceId": {
"type": "string"
},
"sourceType": {
"type": "string"
},
"amount": {
"type": "number"
},
"paymentMethod": {
"type": "string"
},
"paymentType": {
"type": "string",
"enum": [
"charge",
"refund"
]
},
"isManual": {
"type": "boolean"
},
"concept": {
"type": "string"
}
},
"required": [
"sourceId",
"sourceType",
"amount",
"paymentMethod",
"paymentType",
"isManual",
"concept"
]
}Response
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Create payment multiple ¶
Create payment multiplePOST/payments/multiple
Example URI
POST https://payments.spotahome.com/payments/multiple
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"payments": [
{
"sourceId": "8f2dbe69-b68f-4423-bc93-b8b036727a032",
"sourceType": "COMPLAINT",
"amount": 2000,
"paymentMethod": "1",
"paymentType": "charge",
"isManual": true,
"concept": "adjustment-tenantFee"
},
{
"sourceId": "8f2dbe69-b68f-4423-bc93-b8b036727a032",
"sourceType": "COMPLAINT",
"amount": 5000,
"paymentMethod": "1",
"paymentType": "charge",
"isManual": true,
"concept": "adjustment-landlordFee"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"payments": {
"type": "array"
}
},
"required": [
"payments"
]
}Response
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Cancel payment ¶
Cancel paymentPUT/admin/payments/{id}/cancel
Example URI
PUT https://payments.spotahome.com/admin/payments/8f2dbe69-b68f-4423-bc93-b8b036727a032/cancel
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Cancel booking fee payments ¶
Cancel booking fee paymentsPUT/bookings/{id}/fee/cancellation
Example URI
PUT https://payments.spotahome.com/bookings/8f2dbe69-b68f-4423-bc93-b8b036727a032/fee/cancellation
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}View Payment holders ¶
View Payment holdersGET/payment-holders/{id}
Example URI
GET https://payments.spotahome.com/payment-holders/8f2dbe69-b68f-4423-bc93-b8b036727a032
URI Parameters
- id
string(required) Example: 8f2dbe69-b68f-4423-bc93-b8b036727a032
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
200Headers
Content-Type: application/hal+jsonBody
{
"id": "46a18a00-4e9b-463a-8aad-e4165efb4f92",
"name": "Holder name",
"email": "holder@email.com",
"defaultPaymentMethodId": "8f2dbe69-b68f-4423-bc93-b8b036727a032",
"paymentMethods": [
{
"id": "8f2dbe69-b68f-4423-bc93-b8b036727a032",
"type": "paypal",
"provider": "braintree"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"defaultPaymentMethodId": {
"type": "string"
},
"paymentMethods": {
"type": "array"
}
}
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Create payment holder ¶
Create payment holderPOST/payment-holders
Example URI
POST https://payments.spotahome.com/payment-holders
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccBody
{
"userId": "af2dbe69-b68f-4423-bc93-b8b036727a032",
"name": "John Doe",
"email": "johndoe@mail.com"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"userId",
"name",
"email"
]
}Response
204Response
400Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be understood by the server due to malformed syntax",
"status": 400,
"title": "Bad Request",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}Charge downpayment for a booking request ¶
Charge downpayment for a booking requestPOST/booking-requests/{id}/charge
Example URI
POST https://payments.spotahome.com/booking-requests/123456789/charge
URI Parameters
- id
string(required) Example: 123456789
Request
Headers
Content-Type: application/json
Authorization: aa.bb.ccResponse
204Response
401Headers
Content-Type: application/problem+jsonBody
{
"detail": "Unauthorized user",
"status": 401,
"title": "Unauthorized",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
404Headers
Content-Type: application/problem+jsonBody
{
"detail": "The resource was not found",
"status": 404,
"title": "Not Found",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
409Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request could not be completed due to a conflict with the current state of the resource",
"status": 409,
"title": "Conflict",
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"detail",
"status",
"title",
"type"
]
}Response
422Headers
Content-Type: application/problem+jsonBody
{
"detail": "The request was well formed but was unable to be followed due to semantic errors",
"status": 422,
"title": "Unprocessable Entity",
"type": "`http://www.w3.org/Protocols/rfc2616/rfc2616",
"validationMessages": {
"field": {
"stringLength": "The input is less than 6 characters long"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"status": {
"type": "number"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"description": "sec10.html (string, required)"
},
"validationMessages": {
"type": "object",
"properties": {
"field": {
"type": "object",
"properties": {
"stringLength": {
"type": "string"
}
},
"required": [
"stringLength"
]
}
},
"description": "Contains a property for each field that failed validation."
}
},
"required": [
"detail",
"status",
"title"
]
}