API Overview Resources Schemas

Schemas

barringRequestDTO

1
2
3
4
5
6


{
  "active": true,
  "barring_name": "ROAMING",
  "callback_success_url": "https://myserver.com/send/callback/here",
  "callback_error_url": "https://myserver.com/send/callback/here"
}

Name	Type	Required	Description
active	boolean	true	none
barring_name	string	true	Name of the barring to be updated

Property	Values
barring_name	one of [ROAMING, INTERNATIONAL_DESTINATIONS, OUTGOING_VOICE, OUTGOING_SMS, INCOMING_VOICE, INCOMING_SMS, INTERNET, VOICE_PREMIUM_ENTERTAINMENT, VOICE_PREMIUM_INFORMATION, SMS_PREMIUM, SUBSCRIPTION_PREMIUM]

barringCallbackDTO

1
2
3
4


{
  "codeResult": "OK",
  "titleResult": "Barring update was successfully finished"
}

Name	Type	Required	Description
codeResult	string	true	none
titleResult	string	true	none

movementNonSubscribableRequestDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "type": "RECURRING_CHARGE",
  "movement_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T23:00:00Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_movement_unique_id": "123456789",
  "transaction_type_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
type	string	true	none
movement_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	Mandatory just if period_end_datetime is set
period_end_datetime	string(date-time)	false	Mandatory just if period_start_datetime is set
amount	amountDTO	true	none
external_invoice_id	string	false	this field is informative. We are not doing any further processing apart from persisting it
external_movement_unique_id	string	true	none
transaction_type_id	string	true	none
description	string	false	none

Property	Values
type	one of [RECURRING_CHARGE, ONE_TIME_FEE, INSTALLATION_FEE, SUSPENSION_SERVICE_FEE, UNRETURNED_EQUIPMENT_FEE, DISCOUNT]

movementRequestDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


{
  "type": "RECURRING_CHARGE",
  "movement_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T23:00:00Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_movement_unique_id": "123456789",
  "billable": false,
  "concept_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
type	string	true	none
movement_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	Mandatory just if period_end_datetime is set
period_end_datetime	string(date-time)	false	Mandatory just if period_start_datetime is set
amount	amountDTO	true	none
external_invoice_id	string	false	this field is informative. We are not doing any further processing apart from persisting it
external_movement_unique_id	string	true	none
billable	boolean	true	none
concept_id	string	false	none
description	string	false	none

Property	Values
type	one of [RECURRING_CHARGE, ONE_TIME_FEE, INSTALLATION_FEE, SUSPENSION_SERVICE_FEE, UNRETURNED_EQUIPMENT_FEE, DISCOUNT]

refundNonSubscribableRequestDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "refund_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T23:00:00Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_refund_unique_id": "123456789",
  "transaction_type_id": "5432167890",
  "movement_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
refund_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	Mandatory just if period_end_datetime is set
period_end_datetime	string(date-time)	false	Mandatory just if period_start_datetime is set
amount	amountDTO	true	none
external_invoice_id	string	false	this field is informative. We are not doing any further processing apart from persisting it
external_refund_unique_id	string	false	none
transaction_type_id	string	true	none
movement_id	string	true	none
description	string	false	none

refundRequestDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "refund_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T23:00:00Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_refund_unique_id": "123456789",
  "billable": false,
  "movement_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
refund_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	Mandatory just if period_end_datetime is set
period_end_datetime	string(date-time)	false	Mandatory just if period_start_datetime is set
amount	amountDTO	true	none
external_invoice_id	string	false	this field is informative. We are not doing any further processing apart from persisting it
external_refund_unique_id	string	true	none
billable	boolean	true	none
movement_id	string	true	none
description	string	false	none

createPromotionRequestDTO

1
2
3
4
5
6
7


{
  "promotion": {
    "promotion_id": 76,
    "activation_date": "2017-09-15T22:00:00Z",
    "deactivation_date": "2017-09-15T22:00:00Z"
  }
}

Name	Type	Required	Description
promotion	promotionDTO	true	none

updatePromotionRequestDTO

1
2
3


{
  "deactivation_date": "2022-02-24T13:45:10Z"
}

Name	Type	Required	Description
deactivation_date	string(date-time)	true	none

promotionDTO

1
2
3
4
5


{
  "promotion_id": 76,
  "activation_date": "2017-09-15T22:00:00Z",
  "deactivation_date": "2017-09-15T22:00:00Z"
}

Name	Type	Required	Description
promotion_id	string	false	Catalogue unique promotion identifier
activation_date	string(date-time)	false	promotion activation date
deactivation_date	string(date-time)	false	promotion deactivation date

amountDTO

1
2
3
4
5
6
7
8


{
  "value_with_taxes": 12.1,
  "value_without_taxes": 10,
  "tax": {
    "type": "IVA",
    "percentage": 21
  }
}

Name	Type	Required	Description
value_with_taxes	number(float)	false	none
value_without_taxes	number(float)	false	none
tax	taxDTO	false	none

taxDTO

1
2
3
4


{
  "type": "IVA",
  "percentage": 21
}

Name	Type	Required	Description
type	string	true	none
percentage	number(float)	true	none

Property	Values
type	one of [EXEMPTED, IGIC, IVA, IPSI_CEUTA, IPSI_MELILLA, NOT_APPLY, NOT_TAXED]

genericErrorResponseDTO

1
2
3
4


{
  "code": "INVALID_MSISDN",
  "title": "MSISDN does not belong to an active service"
}

Name	Type	Required	Description
code	string	true	Error code string for fast identification
title	string	true	Message description or detail of error

movementUpdateResponseDTO

1
2
3
4


{
  "code": "OK",
  "title": "Movement updated correctly"
}

Name	Type	Required	Description
code	string	true	Code string for fast identification
title	string	true	Message description

barringsDetailResponseDTO

1
2
3
4
5
6


{
  "subscriptionId": 234234234,
  "appliedBarringsMaskCodes": [
    "DEBT_MOBILE_LP"
  ]
}

Name	Type	Required	Description
subscriptionId	integer(int64)	true	Code string for subscription id
appliedBarringsMaskCodes	[string]	true	applied barrings for subscription id

promotionUpdateResponseDTO

1
2
3
4


{
  "code": "OK",
  "title": "Promotion updated correctly"
}

Name	Type	Required	Description
code	string	true	Code string for fast identification
title	string	true	Message description

movementSuccessResponseDTO

1
2
3
4
5


{
  "code": "CREATED",
  "title": "Movement created correctly",
  "movement_id": "8da2b117-ef72-413d-98ce-36d1eb544e44"
}

Name	Type	Required	Description
code	string	true	Code string for fast identification
title	string	true	Message description
movement_id	string	true	Identifier of the created movement

refundSuccessResponseDTO

1
2
3
4
5


{
  "code": "CREATED",
  "title": "Refund created correctly",
  "refund_id": "8da2b117-ef72-413d-98ce-36d1eb544e44"
}

Name	Type	Required	Description
code	string	true	Code string for fast identification
title	string	false	Message description
refund_id	string	true	Identifier of the created refund

PromotionSuccessResponseDTO

1
2
3
4
5


{
  "code": "CREATED",
  "title": "Promotion created correctly",
  "promotion_id": "8da2b117-ef72-413d-98ce-36d1eb544e44"
}

Name	Type	Required	Description
code	string	true	Code string for fast identification
title	string	false	Message description
promotion_id	string	true	Identifier of the created refund

createServiceRequestDTO

1
2
3
4
5
6
7
8
9


{
  "service_id": "string",
  "service_details": {
    "secondary_eid": "string",
    "secondary_iccid": "string"
  },
  "callback_success_url": "https://myserver.com/send/callback/here",
  "callback_error_url": "https://myserver.com/send/callback/here"
}

Name	Type	Required	Description
service_id	string	false	none
service_details	serviceDetailsDTO	true	none

serviceCallbackDTO

1
2
3
4
5


{
  "code": "OK",
  "title": "Service was successfully created",
  "service_id": 600000000
}

Name	Type	Required	Description
code	string	true	none
title	string	true	none
service_id	string	true	none

serviceDetailsDTO

1
2
3
4


{
  "secondary_eid": "string",
  "secondary_iccid": "string"
}

None

updateServiceDeviceRequestDTO

1
2
3
4
5
6
7
8
9


{
  "category": "eSIM",
  "new_service_device_details": {
    "iccid": 8934011411551283000,
    "eid": 8.903302331217e+31
  },
  "callback_success_url": "https://myserver.com/send/callback/here",
  "callback_error_url": "https://myserver.com/send/callback/here"
}

Name	Type	Required	Description
category	string	true	none
new_service_device_details	deviceDetailsDTO	true	none

Property	Values
category	one of [STB, SMARTWATCH, TABLET, ROUTER, PBX, SMARTPHONE, WIFI_EXTENDER, OTHER, SIM, eSIM]

deviceDetailsDTO

1
2
3
4


{
  "iccid": 8934011411551283000,
  "eid": 8.903302331217e+31
}

None

eSIMDeviceDTO

1
2
3
4


{
  "iccid": 8934011411551283000,
  "eid": 8.903302331217e+31
}

Name	Type	Required	Description
iccid	string	false	Circuit Card Identification Number associated to the eSIM
eid	string	false	eUICC Identifier associated to the eSIM

multisimServiceDTO

1
2
3
4


{
  "secondary_eid": "string",
  "secondary_iccid": "string"
}

Name	Type	Required	Description
secondary_eid	string	true	none
secondary_iccid	string	true	none

updateMultisimServiceDTO

1
2
3
4


{
  "new_secondary_eid": "string",
  "new_secondary_iccid": "string"
}

Name	Type	Required	Description
new_secondary_eid	string	true	none
new_secondary_iccid	string	true	none

serviceTypeDTO

1

"multisim"

Name	Type	Required	Description
anonymous	string	false	none

Property	Values
anonymous	one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

callbackDTO

1
2
3
4


{
  "callback_success_url": "https://myserver.com/send/callback/here",
  "callback_error_url": "https://myserver.com/send/callback/here"
}

Name	Type	Required	Description
callback_success_url	string(uri)	true	none
callback_error_url	string(uri)	true	none