CarrierBillingCheckOut

Repository to describe, develop, document and test the CarrierBilling APIs

Scope

• Service APIs for “CarrierBillingCheckOut” (see APIBacklog.md)
• It provides the API consumer with the ability to:
  • Trigger carrier billing payment request (in one or two steps), which is a process that allows API consumers to make purchases by charging payments against Telco Operator Billing Systems.
    • Follow up of payment, by means of query endpoints to get information about a list of payments or a specific payment.
  • Trigger carrier billing refund request, which is a process that allows API consumers to ask for a total or partial return of the amount associated to a previous performed payment.
    • Follow up of refund, by means of query endpoints to get information about a list of refunds or a specific refund.
  • NOTE: The scope of these APIs should be limited (at least at a first stage) to 4G and 5G.
• Describe, develop, document and test the APIs (with 1-2 Telcos)
  • Started: October 2022

Release Information

• Note: Please be aware that the project will have updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. For best results, use the latest available release.

• The Release r2.2 for the Carrier Billing APIs Family is available.
  This is a public release.

• The release r2.2 is available in r2.2, and includes the following APIs:

• API name: Carrier Billing (Payment) - API Definition v0.4.0 with inline documentation:

  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

• API name: Carrier Billing Refund - API Definition v0.2.0 with inline documentation:

  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

• Other releases of this sub project are available in CarrierBillingCheckout Releases
• For changes see CHANGELOG.md

Contributing

• Meetings are held virtually
  • Schedule: Bi-Weekly, Wednesdays 13:00 - 14:00 UTC
  • Registration / Join
  • Minutes: Access Meeting minutes
• Mailing List
  • Subscribe / Unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-cbc.
  • A message to the community of this Sub Project can be sent using sp-cbc@lists.camaraproject.org.