Carrier Billing Payment API documentation + Yaml update

[bigludo7]

Hello Please see a proposal for Carrier Billing Payment API documentation. I followed QoD API template. Source puml are provided for the illustration. A new version of the yaml is also provided.

[Mohammed-nayeemuddin]

Dear Robert,

I went through the Yaml and I have few queries, if you could please answer.

1. /payments/confirm/{paymentId}

      We need to return 204 in success when there is no response but currently you are returning 200.
   
   2.  /payments/prepare   - paymentId - I don’t see in the response of 1 step or 2 step . Can you please highlight in Yaml
   
   3.  purchase notification callback – is it valid in case of 2 step or 1 step or both?

   4. I don’t see any resource for OTP in the yaml.

[bigludo7]

Following @naymohammed.c@stc.com.sa review, Yaml updated:

• replace return code 200 to 202 for Payment confirmation
• add attribute paymentId in POST request (for one step as 2 steps process)

[bigludo7]

Hi Nayeemuddin

Thanks for your review – this is really helpful

1/ You’re perfectly right – 200 is not good. It should be 202 I think (202 (Accepted) code indicated that the request has been accepted to be processed, but it has not ended.) – as specified here: WorkingGroups/API-design-guidelines.md at main · camaraproject/WorkingGroups (github.com) --> fixed

2/ you’re right. My bad ! I need to add it --> fixed

3/ Yes in both case – for my perspective notification could be triggered for any payment status change

4/ For me this outside of the scope of this API as we work on a separate OTP API that could be used in this UC. I imagine in our different company we can have separate way to get user consent for this payment so I prefer to keep this outside the core function of payment.

[PedroDiez]

@bigludo7 it appears a conflict, maybe you can fix it and after that merge this PR. So additional PR can be created after to update Payment State engine picture

[bigludo7]

@PedroDiez I have fixed 2 issues for the conflict. If still issue we can have a quick call tomorrow to fix it together?

[PedroDiez]

sure Ludovic!

[PedroDiez]

seems OK, you can merge this PR and later the one with updated picture