Open APIs

Expand all | Collapse all

TMF 670 - Handling of externally initiated payments

  • 1.  TMF 670 - Handling of externally initiated payments

    TM Forum Member
    Posted Mar 10, 2021 10:04

    Hi
    The payment methods can be classified as
    1) Application initiated payments (like Credit Card, Bank Account Debit)
    2) Externally processed payments (like Cash, Check, Voucher etc)

    For the #1 category above, we would need to store the payment method details like CC Number, Expiry, Bank Account No etc so we can request for the payment. However, for the #2 category, we don't really need to store anything in the application but we should be able to record such payments and allocate to the account.
    In terms of CX, for #2 category of payment methods, does one need to store and display that user has selected say cash as the payment method? Typically these can be handled as invoices against which payments are made externally and the recorded against the invoice.

    Can someone please clarify this?



    ------------------------------
    Mukesh Kumar
    Oracle Corporation
    ------------------------------


  • 2.  RE: TMF 670 - Handling of externally initiated payments

    TM Forum Member
    Posted Mar 11, 2021 02:30
    Hi Mukesh
    For cases like this, we have the <Entity>RefOrValue pattern, which allows you to:
    • set a reference to an existing addressable entity (e.g. credit card, direct debit); Ref
    • use an inline value object with the un-addressable entity (e.g. cash, cheque); Value
    So the API consumer can provide the details inline, and it's up to the API implementation to decide whether to store the payment method details. Unless you're short of storage, I don't see why you would not save the details inline, apart from anything else to allow auditing and follow-ups.

    Hope it helps

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 3.  RE: TMF 670 - Handling of externally initiated payments

    TM Forum Member
    Posted Mar 11, 2021 05:34
    Hi @Jonathan Goldberg
    Thanks for the response. That helped me refine my question further.
    The question is more pertaining to existing addressable entity vs un-addressable entity. Does the application need to store cash/voucher/check as addressable entity? The example for GET /paymentMethods/v1/paymentMethod (in pages 14-16 in TMF 670 R17.5.0) shows that these are also stored somewhere in the database.
    However, I can't think of use cases where one needs to. I can think of cases where one needs to fetch the payments done using these types of entities but that would be more appropriate within TMF 676.
    For 670, I guess spec should only prescribe that payment methods like cash/voucher/check needs to be supported with the minimum set of fields. However, a GET on payment methods should return these types only if we give user the option to select Cash/Check/Voucher as payment method and also show these information in the UI.
    Do you think this makes sense?

    Regards
    Mukesh

    ------------------------------
    Mukesh Kumar
    Oracle Corporation
    ------------------------------



  • 4.  RE: TMF 670 - Handling of externally initiated payments

    TM Forum Member
    Posted Mar 11, 2021 08:11
    Hi Mukesh
    It probably doesn't make sense to store as an addressable managed entity one-off payment methods. But that's an implementation decision, I believe that the Open API model and design should be enabling rather than limiting.
    Perhaps we should suggest some textual clarification for these two APIs (payment management and payment method) to make this explicit?

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 5.  RE: TMF 670 - Handling of externally initiated payments

    TM Forum Member
    Posted Mar 11, 2021 11:47
    Edited by Mukesh Kumar Mar 11, 2021 11:47
    Thanks @Jonathan Goldberg
    I think that would be helpful. Please let me know if you need anything from my side
    Thanks again for taking time to respond to this.
    ​Regards

    ------------------------------
    Mukesh Kumar
    Oracle Corporation
    ------------------------------