Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
description: "Service Enabling Payments against Operator Carrier Billing Systems\n\n# Introduction\n\nThe Carrier Billing API provides programmable interface for developers and other users (capabilities consumers) to charge an amount on a mobile line.\nIt can be easily integrated and allows end-users to buy digital content in an easy & secured way. The API provides management of a payment entity and its associated lifecycle.\n\n# Relevant terms and definitions\n\n- **Carrier Billing**:\nAn online payment process which allows users to make purchases by charging payments against Telco Operator Billing Systems, accordingly to the user's configuration in the Telco Operator. In a common usage in the industry, the payment is processed on current account balance or charged on next bill generated for this line.\n\n- **Payment**:\nThe process of paying for a (set of) good(s)/service(s).\n\n- **1-STEP Payment**:\nPayment process performed in one phase (i.e. one action), that involves all the Telco Operator Carrier Billing Systems checking and trigger the charging request against Billing Systems.\n\n- **2-STEP Payment**:\nPayment process performed in two phases (i.e. two actions). First action deals with payment preparation request to guarantee the reservation of the involved amount. Second action is an explicit confirmation or cancellation of the payment by the user. Any payment not confirmed/cancelled by a given user is discarded after some time in order to avoid inconsistency in the billing systems.\n\n# API Functionality\n\nThis API allows to third party clients to request the payment of a (set of) digital good(s)/service(s), as well as to retrieve information about a specific payment or a list of payments.\n\nIn the scope of **version v0.5rc1, only one-off payments are covered**. Recurrent payments (a.k.a. payment subscriptions) are not covered so far.\n\nThe API provides several endpoints/operations:\n- An endpoint to request a 1-STEP Payment, named `createPayment`.\n- A set of endpoints to request a 2-STEP Payment:\n - One endpoint to setup the payment reservation, named `preparePayment`.\n - A couple of endpoints to confirm/cancel such payment reservation, named `confirmPayment` and `cancelPayment` respectively.\n- A set of endpoints to retrieve information about a list of payments or a specific payment (identified by its specific `paymentId`), named `retrievePayments` and `retrievePayment` respectively.\n- A callback endpoint where API Server can send notifications about a payment procedure, as defined within `createPayment` and `preparePayment` operations, towards the `sink` when provided by API client.\n\nThe usage of the API is based on Payment resource, which can be created (in 1-STEP or 2-STEP Payment process), confirmed/cancelled (for 2-STEP Payment process), and queried/retrieved (list of payments or a specific payment).\n\nBefore starting to use the API, the developer needs to know about the below specified details:\n- **Payment service endpoint**: The URL pointing to the RESTful resource of the payment API. As 1-STEP and 2-STEP processes are managed, 2 separate tags _`One Step Payment`_ and _`Two Step Payment`_ have been defined to explicitly distinguish them in the API specification. A third tag _`Payment`_ is defined for common operations in both processes (query/retrieve list of payments or a specific payment).\n- **1-STEP & 2-STEP Payment**:\n - **1-STEP Payment**: The request intent is to charge an amount to the mobile line. When the server receives the request, it will check the user account associated with this line and, if nothing prevents it, the amount is charged and will be either bill in next invoice or removed from current line credit/balance.\n - **2-STEP Payment**: The first call is to request a payment preparation, which implies an amount reservation. The amount is not charged and the server has to be ready to get a confirmation or a cancellation to perform the payment. Only when the confirmation is done, payment is charged. Depending on business rules of the Telco operator, a `prepared` payment could expire after a defined delay.\n- **Notification URL**: Developers may provide a callback URL (`sink` param) on which status change notifications, regarding the payment, can be received from the Telco Operator. This is an optional parameter.\n\nFollowing diagram shows the API resources operation sequencing:\n\n\nFollow picture provides information about the payment state engine (state description & transition):\n\n\nState transitions:\n\n**1-STEP Payment**\n\nIf `createPayment` is a **SYNC** process:\n- Response contains `paymentId` and paymentStatus=`succeeded`.\n- In case of any error scenario `paymentId` is not created.\n\nIf `createPayment` is an **ASYNC** process:\n- Response contains `paymentId` and paymentStatus=`processing`. After completion:\n - When payment is successfully completed then paymentStatus=`succeeded`.\n - When payment is not successfully performed then paymentStatus=`denied`.\n- In case of any error scenario `paymentId` is not created.\n\n**2-STEP Payment**\n\nFIRST STEP\n\nIf `preparePayment` is a **SYNC** process:\n- **Case A** - `validationInfo` is NOT provided in response.\n - Response contains `paymentId` and paymentStatus=`reserved`.\n- **Case B** - `validationInfo` is provided in response.\n - Response contains `paymentId` and paymentStatus=`pending_validation`.\n- In case of any error scenario `paymentId` is not created.\n\nIf `preparePayment` is an **ASYNC** process:\n- **Case A** - `validationInfo` is NOT provided in response.\n - Response contains `paymentId` and paymentStatus=`processing`. After completion:\n - When payment preparation is successfully completed then paymentStatus=`reserved`.\n - When payment preparation is not successfully performed then paymentStatus=`denied`.\n- **Case B** - `validationInfo` is provided in response.\n - Response contains `paymentId` and paymentStatus=`processing`. After completion:\n - When payment preparation is successfully completed then paymentStatus=`pending_validation`. [1]\n - When payment preparation is not successfully performed then paymentStatus=`denied`.\n- In case of any error scenario `paymentId` is not created.\n\n[OPTIONAL] VALIDATE STEP [1]\n\nAfter `validatePayment`, paymentStatus=`reserved` OR `denied`, depending whether it was successful or not.\n\nSECOND STEP\n\nAfter `confirmPayment`, paymentStatus=`succeeded` OR `denied`, depending whether it was successful or not.\n\nAfter `cancelPayment`, paymentStatus=`cancelled`.\n\n# Generic Clarification about optional parameters\n\nRegarding optional parameters, they can be conditionally mandatory for a Telco Operator to implement them based on business scenarios or applicable regulations in a given market.\n\nNOTE: Within a given market, in a multi Telco Operator ecosystem, the set of optional parameters to be implemented MUST be aligned among involved Telco Operators.\n\n# Authorization and authentication\n\nThe \"Camara Security and Interoperability Profile\" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile.\n\nThe specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation.\n\nIn cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design.\n\n# Identifying the phone number from the access token\n\nThis API requires the API consumer to identify a phone number as the subject of the API as follows:\n- When the API is invoked using a two-legged access token, the subject will be identified from the optional `phoneNumber` field, which therefore MUST be provided.\n- When a three-legged access token is used however, this optional identifier MUST NOT be provided, as the subject will be uniquely identified from the access token.\n\nThis approach simplifies API usage for API consumers using a three-legged access token to invoke the API by relying on the information that is associated with the access token and was identified during the authentication process.\n\n## Error handling:\n\n- If the subject cannot be identified from the access token and the optional `phoneNumber` field is not included in the request, then the server will return an error with the `422 MISSING_IDENTIFIER` error code.\n\n- If the subject can be identified from the access token and the optional `phoneNumber` field is also included in the request, then the server will return an error with the `422 UNNECESSARY_IDENTIFIER` error code. This will be the case even if the same phone number is identified by these two methods, as the server is unable to make this comparison.\n\n# Additional CAMARA error responses\n\nThe list of error codes in this API specification is not exhaustive. Therefore the API specification may not document some non-mandatory error statuses as indicated in `CAMARA API Design Guide`.\n\nPlease refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version.\n\nAs a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API.\n\n# Further info and support\n\n(FAQs will be added in a later version of the documentation)"
version: wip
title: Carrier Billing Two Step Payment API
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
x-camara-commonalities: wip
servers:
- url: '{apiRoot}/carrier-billing/vwip'
variables:
apiRoot:
default: http://localhost:9091
description: API root, defined by the service provider
tags:
- name: Two Step Payment
description: Operations to manage Two Step Payment procedure
paths:
/payments/prepare:
post:
security:
- openId:
- carrier-billing:payments:create
tags:
- Two Step Payment
summary: Prepare (reserve) a payment
operationId: preparePayment
description: Prepare a new payment procedure. Carrier Billing Server will apply the charging according to business configuration for the end user.
parameters:
- $ref: '#/components/parameters/x-correlator'
requestBody:
description: Amount transaction
content:
application/json:
schema:
$ref: '#/components/schemas/BodyAmountReservationTransactionForReserveInput'
required: true
callbacks:
notifications:
'{$request.body#/sink}':
post:
security:
- {}
- notificationsBearerAuth: []
tags:
- Payment Notifications
summary: Carrier Billing payment notifications
operationId: preparePaymentNotification
description: 'Important: This endpoint is exposed by the API client, accepting requests in the defined format.
The Carrier Billing server will call this endpoint whenever any carrier billing related event occurs.
'
parameters:
- $ref: '#/components/parameters/x-correlator'
requestBody:
description: Creates a new carrier billing payment notification
content:
application/cloudevents+json:
schema:
$ref: '#/components/schemas/CloudEvent'
required: true
responses:
'204':
description: Successful notification
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
'400':
$ref: '#/components/responses/Generic400'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/Generic403'
'410':
$ref: '#/components/responses/Generic410'
'429':
$ref: '#/components/responses/Generic429'
responses:
'201':
description: Created
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
$ref: '#/components/schemas/BodyAmountReservationTransactionForReserve'
'400':
$ref: '#/components/responses/Payment2StepPrepareInvalid400'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/PaymentPermissionDenied403'
'404':
$ref: '#/components/responses/IdentifierNotFound404'
'409':
description: Conflict
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorInfo'
- type: object
properties:
status:
enum:
- 409
code:
enum:
- ALREADY_EXISTS
examples:
GENERIC_409_ALREADY_EXISTS:
summary: Generic Already Exists
description: Trying to create an existing resource
value:
code: ALREADY_EXISTS
status: 409
message: Another session is created for the same UE
'422':
$ref: '#/components/responses/PaymentUnprocessable422'
'429':
$ref: '#/components/responses/Generic429'
/payments/{paymentId}/validate:
post:
security:
- openId:
- carrier-billing:payments:write
tags:
- Two Step Payment
summary: Validate a payment
operationId: validatePayment
description: Validate a given payment with a code, identified by its paymentId. This process is applicable for 2-STEP, when optionally required by business case.
parameters:
- name: paymentId
in: path
description: The payment identifier returned when the payment preparation was created.
schema:
type: string
required: true
- $ref: '#/components/parameters/x-correlator'
requestBody:
description: Payment Validation
content:
application/json:
schema:
$ref: '#/components/schemas/ValidatePayment'
required: true
responses:
'204':
description: Validation Succeeded
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
'400':
$ref: '#/components/responses/ValidatePaymentInvalid400'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/Generic403'
'404':
$ref: '#/components/responses/Generic404'
'409':
description: Conflict
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorInfo'
- type: object
properties:
status:
enum:
- 409
code:
enum:
- ALREADY_EXISTS
examples:
GENERIC_409_ALREADY_EXISTS:
summary: Conflict
description: paymentId already validated
value:
code: ALREADY_EXISTS
status: 409
message: Payment already validated
'429':
$ref: '#/components/responses/Generic429'
/payments/{paymentId}/confirm:
post:
security:
- openId:
- carrier-billing:payments:write
tags:
- Two Step Payment
summary: Confirm a payment
operationId: confirmPayment
description: Confirm a reservation of a given payment, identified by its paymentId.
parameters:
- name: paymentId
in: path
description: The payment identifier returned when the payment preparation was created.
schema:
type: string
required: true
- $ref: '#/components/parameters/x-correlator'
requestBody:
description: capture PhoneNumber for payment operation
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneNumber'
required: true
responses:
'202':
description: Payment confirmation accepted
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
'400':
$ref: '#/components/responses/Payment2StepInvalid400'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/PaymentConfirmPermissionDenied403'
'404':
$ref: '#/components/responses/Identifier2StepNotFound404'
'409':
$ref: '#/components/responses/PaymentConfirmConflict409'
'422':
$ref: '#/components/responses/PaymentSecondStepUnprocessable422'
'429':
$ref: '#/components/responses/Generic429'
/payments/{paymentId}/cancel:
post:
security:
- openId:
- carrier-billing:payments:write
tags:
- Two Step Payment
summary: Cancel a payment
operationId: cancelPayment
description: Cancel a reservation of a given payment, identified by its paymentId.
parameters:
- name: paymentId
in: path
description: The payment identifier returned when the payment preparation was created.
required: true
schema:
type: string
- $ref: '#/components/parameters/x-correlator'
requestBody:
description: capture PhoneNumber for payment operation
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneNumber'
required: true
responses:
'202':
description: Payment Cancellation Accepted
headers:
x-correlator:
$ref: '#/components/headers/x-correlator'
'400':
$ref: '#/components/responses/Payment2StepInvalid400'
'401':
$ref: '#/components/responses/Generic401'
'403':
$ref: '#/components/responses/PaymentCancelPermissionDenied403'
'404':
$ref: '#/components/responses/Identifier2StepNotFound404'
'409':
$ref: '#/components/responses/PaymentCancelConflict409'
'422':
$ref: '#/components/responses/PaymentSecondStepUnprocessable422'
'429':
$ref: '#/components/responses/Generic429'
components:
schemas:
ErrorInfo:
type: object
required:
- status
- code
- message
properties:
status:
type: integer
description: HTTP response status code
code:
type: string
description: A human-readable code to describe the error
message:
type: string
description: A human-readable description of what the event represents
BodyAmountReservationTransactionForReserveInput:
required:
- amountTransaction
type: object
properties:
amountTransaction:
$ref: '#/components/schemas/AmountReservationTransactionForReserveInput'
sink:
type: string
format: uri
pattern: ^https:\/\/.+$
description: The address to which events shall be delivered, using the HTTP protocol.
example: https://endpoint.example.com/sink
sinkCredential:
allOf:
- description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
- $ref: '#/components/schemas/SinkCredential'
SinkCredential:
type: object
properties:
credentialType:
type: string
enum:
- PLAIN
- ACCESSTOKEN
- REFRESHTOKEN
description: The type of the credential. Only `ACCESSTOKEN` is supported so far.
discriminator:
propertyName: credentialType
mapping:
PLAIN: '#/components/schemas/PlainCredential'
ACCESSTOKEN: '#/components/schemas/AccessTokenCredential'
REFRESHTOKEN: '#/components/schemas/RefreshTokenCredential'
required:
- credentialType
PaymentAmountForReserve:
type: object
required:
- chargingInformation
properties:
chargingInformation:
$ref: '#/components/schemas/ChargingInformation'
chargingMetaData:
$ref: '#/components/schemas/ChargingMetaData'
paymentDetails:
$ref: '#/components/schemas/PaymentDetails'
CloudEvent:
description: The notification format
required:
- id
- source
- specversion
- type
- time
properties:
id:
type: string
description: Identifier of this event, that must be unique in the source context.
minLength: 1
example: sd5e-uy52-88t4-za66
source:
$ref: '#/components/schemas/Source'
type:
type: string
description: Type of event as defined in each CAMARA API
minLength: 25
example: org.camaraproject.carrier-billing.v0.payment-reserved
specversion:
type: string
description: Version of the specification to which this event conforms (must be 1.0 if it conforms to cloudevents 1.0.2 version)
minLength: 3
example: '1.0'
datacontenttype:
type: string
description: media-type that describes the event payload encoding, must be "application/json" for CAMARA APIs
example: application/json
data:
type: object
description: Event details payload described in each CAMARA API and referenced by its type
time:
$ref: '#/components/schemas/DateTime'
discriminator:
propertyName: type
mapping:
org.camaraproject.carrier-billing.v0.payment-pending-validation: '#/components/schemas/EventPaymentPendingValidation'
org.camaraproject.carrier-billing.v0.payment-reserved: '#/components/schemas/EventPaymentReserved'
org.camaraproject.carrier-billing.v0.payment-completed: '#/components/schemas/EventPaymentCompleted'
org.camaraproject.carrier-billing.v0.payment-cancelled: '#/components/schemas/EventPaymentCancelled'
org.camaraproject.carrier-billing.v0.payment-denied: '#/components/schemas/EventPaymentDenied'
PhoneNumber:
type: object
properties:
phoneNumber:
type: string
description: 'Identifies the mobile account to be charged.
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ''+''.
Additional Considerations:
- Take a look to section `# Identifying the phone number from the access token` regarding the use of this field.'
pattern: ^\+[1-9][0-9]{4,14}$
example: '+34671999000'
XCorrelator:
type: string
pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$
example: b4333c46-49c0-4f62-80d7-f0ef930f1c46
DateTime:
type: string
format: date-time
description: Timestamp when the occurrence happened. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
example: '2023-11-03T12:27:10Z'
ValidatePayment:
type: object
required:
- authorizationId
- code
properties:
authorizationId:
type: string
description: Unique authorization identifier for a specific payment.
example: Fn34o8g239v3wrb3t
code:
type: string
description: Code received via SMS to validate and authorize a specific payment, only needed when business case requires it. Sending of this code is outside this specification.
example: '352673'
ChargingMetaData:
type: object
properties:
merchantName:
type: string
description: Indicates the merchant name. Allows aggregators/partners to specify the actual merchant name
example: EA Sports
merchantIdentifier:
type: string
description: Indicates the merchant identifier. Allows aggregators/partners to specify the actual merchant identifier
example: eas-12345
fee:
type: number
format: float
multipleOf: 0.01
description: Percentage of the amount to be received by the requester
example: 10
purchaseCategoryCode:
type: string
description: A category defining the type of service, product or media being purchased
example: games
channel:
type: string
description: The channel over which the requester is interacting with the merchant (e.g. WAP, Web, SMS...)
example: web
serviceId:
type: string
description: The identifier of the partner/merchant service being purchased
example: games-online
productId:
type: string
description: The product identifier to be combined with the `serviceId` to uniquely identify the product being purchased. For example if the `serviceId` relates to a VOD service, the `productId` can specify the movie rented
example: '138235321'
ChargingInformation:
type: object
required:
- amount
- currency
- description
properties:
amount:
type: number
format: float
multipleOf: 0.001
minimum: 0.001
description: Amount to be charged or reserved.
example: 100
currency:
type: string
description: Currency code in which amount is expressed as defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
example: EUR
description:
type: string
description: Description text to be used for information and billing text
example: FIFA EA Sports 24
isTaxIncluded:
type: boolean
default: false
description: If true, the `amount` is tax included, if false the `amount` is provided without tax. In both cases, `taxAmount` could be indicated to provide tax amount.
taxAmount:
type: number
format: float
multipleOf: 0.001
minimum: 0
description: 'The tax amount charged by the merchant. Indicated when the merchant is the one applying taxes. This field also provides an indicator to the downstream billing system.
'
example: 21
Source:
type: string
format: uri-reference
minLength: 1
description: "Identifies the context in which an event happened - be a non-empty `URI-reference` like:\n- URI with a DNS authority:\n * https://github.com/cloudevents\n * mailto:cncf-wg-serverless@lists.cncf.io\n- Universally-unique URN with a UUID:\n * urn:uuid:6e8bc430-9c3a-11d9-9669-0800200c9a66\n- Application-specific identifier:\n * /cloudevents/spec/pull/123\n * 1-555-123-4567"
example: https://notificationSendServer12.supertelco.com
ValidationInfo:
type: object
required:
- action
properties:
action:
type: string
enum:
- open
- validate
description: Action to be done regarding otp validation.
discriminator:
propertyName: action
mapping:
open: '#/components/schemas/Open'
validate: '#/components/schemas/Validate'
example:
action: validate
authorizationId: Fn34o8g239v3wrb3t
PaymentItem:
type: object
required:
- id
- amount
- currency
- description
properties:
id:
type: string
description: Unique payment item identifier. Relevant to uniquely identify an item within a given payment when `paymentDetails` are provided and also to correlate information when a refund regarding this item is performed, by means of using `refundDetails`.
example: 3goug3uvu32v3b
amount:
type: number
format: float
multipleOf: 0.001
minimum: 0.001
description: Specific amount to be charged or reserved referred to a specific item.
example: 100
currency:
type: string
description: Currency code in which amount is expressed as defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html).
example: EUR
description:
type: string
description: Description text to be used for information and billing text referred to a specific item.
example: FIFA EA Sports 24
isTaxIncluded:
type: boolean
default: false
description: If true, the `amount` is tax included, if false the `amount` is provided without tax. In both cases, `taxAmount` could be indicated to provide tax amount.
taxAmount:
type: number
format: float
multipleOf: 0.001
minimum: 0
description: 'The tax amount charged by the merchant. Indicated when the merchant is the one applying taxes. This field also provides an indicator to the downstream billing system.
'
example: 21
PaymentDetails:
type: array
description: Detailed description of the concepts/items considered within a specific payment procedure.
minItems: 1
items:
$ref: '#/components/schemas/PaymentItem'
AmountReservationTransactionForReserveInput:
type: object
required:
- paymentAmount
- referenceCode
properties:
phoneNumber:
type: string
description: 'Identifies the mobile account to be charged.
A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, prefixed with ''+''.
Additional Considerations:
- Take a look to section `# Identifying the phone number from the access token` regarding the use of this field.'
pattern: ^\+[1-9][0-9]{4,14}$
example: '+34671999000'
clientCorrelator:
type: string
description: Uniquely identifies this create payment request. If there is a communication failure during the payment request, using the same clientCorrelator when retrying the request allows the operator to avoid applying the same charge twice. This field SHOULD be present.
example: req-12f2pgh448gh2hvrfrv
paymentAmount:
$ref: '#/components/sch
# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gsma/refs/heads/main/openapi/gsma-two-step-payment-api-openapi.yml