Open APIs

Hello

For "topupBalance" Resource : In which use case a ""voucher"" on topupBalance can be used ? can we use it to store a pin code for topup via Orange Money

Hi Imene

The voucher in the TopupBalance entity (task resource) was typically used for the (old) scratch cards PIN (Orange Top-Up).

For topping up via the Orange digital wallet, have you considered the Payment Method (see below).   You can extend these entities to align with your specific use case.

Hello Thank you for your reply , so It will be like this :

POST …/api/prepaybalancemanagement/v1/topupBalance

{
  "channel": {
    "name": "xx"
  },
  "logicalResource": [
    {
      "@type": "msisdn",
      "value": "010101010101"
    }
  ],
  "paymentMethod": {
    "id": "PM1",

     "name": "DigitalWallet",
    "authorizationCode": "1234567",
    "@type": "DigitalWallet",
    
  },
  "voucher":""
}

------------------------------
Imene Tekaya
Sofrecom Tunisie
------------------------------

Yes, that looks about right for the TMF654 V4 payload although your endpoint (URL) has a v1 and lowercase rather than lowerCamelCase for the API name.  If you plan to integrate via the TMF676 Payment Management API, you can use the PaymentMethod at this level instead.  All depends on your specific implementation/requirements.

Note that the TMF654 V5 has recently been published.