Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

With “With this service, the calling app can request the underlying provider to generate (and optionally send) an invoice to a customer for a specific payment or service. Apps will pass in the details of the items to be paid for as well as the payer’s details and any authorisation details that may be required. OnePipe will in turn forward to the provider’s dedicated implementation. Providers will be required to respond the details of the invoice generated and a link with which the App can access it digitally.

...

Code Block
languagejson
{
  "requestre
  quest_ref":"{{request_ref}}", 
  "request_type":"send_invoice",
  "auth": {
    "type": "null", 
    "secure": "{{null}}", 
    "auth_provider": "OnePipe",
    "route_mode": null
  },
  "transaction": {
    "mock_mode": "live", 
    "transaction_ref": "{{transaction_ref}}", 
    "transaction_desc": "A random transaction", //description that shouldcarry to the invoice
    "transaction_ref_parent": null, 
    "amount": 0,//amoun expected to be paid
    "customer":{
    	"customer_ref": "{{customer_id}}",
    	"firstname": "Uju",
        "surname": "Usmanu",
    	"email": "ujuusmanu@gmail.com",//the recipient of the invoice
    	"mobile_no": "234802343132"//the recipient of the invoice
    },
    "meta":{
    	"a_key":"a_meta_value_1",
    	"another_key":"a_meta_value_2"
    },
    "details": {
      "invoice_number": "00001",//optional. Provider can generate one
      "due_date": "09-08-2020",
      "page_id": "{{SMP Page ID}}" //optional.
      "payment_items": [
        {
          "item_description": "A big blag bag",
          "item_code": "ITEM001",
          "item_amount": 2000000          
        },
        {
          "item_description": "A big blag bag",
          "item_code": "ITEM001",
          "item_amount": 2000000
        }
      ],
      "reminders": [
        {
          "reminder_date": "09-08-2020",
          "reminder_title": "It's been 8 days, pay up!"
          "reminder_message": "The quick brown fox jumps over the lazy dog"
        },
        {
          "reminder_date": "09-08-2020",
          "reminder_title": "It's been 8 days, pay up!"
          "reminder_message": "The quick brown fox jumps over the lazy dog"
        }
      ]      
    }
  }
}

...