Versions Compared

Key

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

...

Interface specification - (OnePipe → Provider)

Request

Code Block
languagejson
{
    "request_ref":"{{request-ref}}", 
    "request_type":"lookup_customer_reference",
    "auth": {
      "type": null,
      "secure": null,
      "auth_provider": "Beeceptor",
      "route_mode":"provider | options | null"
    },
    "transaction": {
      "mock_mode": "live", 
      "transaction_ref": "{{transaction-ref}}", 
      "transaction_desc": "A random transaction", 
      "transaction_ref_parent": "", 
      "amount": 10000,
      "customer":{
      	"customer_ref": "{{customer id}}", //the unique payment ref with the biller
      	"firstname": "Uju",
    	"surname": "Usmanu",
      	"email": "ujuusmanu@gmail.com",
      	"mobile_no": "234802343132"
      },
      "meta":{
      	"a_key":"a_meta_value_1",
      	"another_key":"a_meta_value_2"
      },
      "details": {
        "biller_id": "{{code representing the biller}}",
        "biller_item_id": "{{code representing the biller's specific product}}"
      }
    }
    "client_info": {
        "name": "TrustPay",
        "id": null,
        "bank_cbn_code": null,
        "bank_name": null,
        "console_url": null,
        "js_background_image": null,
        "css_url": null,
        "logo_url": "https://trustpay.onepipe.io/img/trustpay_logo_console.png",
        "footer_text": "Brought to you by <strong>SunTrust Bank</strong>",
        "options": [
            "BANK.TRANSFER",
            "CARD"
        ],
        "primary_color": "#b37038",
        "secondary_color": "#b37038",
        "primary_button_color": "#b37038",
        "modal_background_color": "linear-gradient(147.44deg, #d8903c 26.99%, #e69921 74.1%)",
        "payment_option_color": "rgba(76, 61, 47, 0.08)",
        "payment_option_active_color": "rgba(31, 31, 31, 0.25)",
        "app_color": "#b37038"
    },
    "app_info": {
      "name": "VictorMotors",
      "id": "5cdab3332b7d4100015f0db4",
      "beneficiary_account_no": "0001137069",
      "extras": {/*this will contain an array of provider override settings*/}
    }
  }
}

Response

...

Read this closely.