Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Next »

Overview

With this service, the calling apps can instruct a provider via OnePipe to send an email to a specified email address or customer_ref.

Before you proceed: Please read this.

Commercial model

The Provider needs to send a share of income to the settlement account at the host; which will then be shared with OnePipe, host and ISO. Parties that share the fees are:

  1. OnePipe

  2. Host client

  3. ISO

Settlement & fees model

Model

How it works

Invoice

The host client will invoice the calling app periodically for all calls to the endpoint.

Process flows

Sequence of calls

  1. App calls /transact with the right auth details

  2. Provider responds with any of the completion codes Successful or Failed.

  3. To query the status of a transaction, the app can call /transact/query

INTERFACE SPECIFICATION (APP → ONEPIPE)

Request (Transact)

{
  "request_ref":"{{request_ref}}", 
  "request_type":"send_email",
  "auth": {
    "type": "bank.account | card | wallet | msisdn", 
    "secure": "{{encrypted(bank account number | card details | wallet | msisdn)}}", //if payment should be collected realtime, it would be charged here
    "auth_provider": "Beeceptor",
    "route_mode": null
  },
  "transaction": {
    "mock_mode": "live", 
    "transaction_ref": "{{transaction_ref}}", 
    "transaction_desc": "A random transaction", 
    "transaction_ref_parent": null, 
    "amount": 0,
    "customer":{
    	"customer_ref": "{{customer_id}}",
    	"firstname": "Uju",
  		"surname": "Usmanu",
    	"email": "ujuusmanu@gmail.com",//the recipient of the message
    	"mobile_no": "234802343132"
    },
    "meta":{
    	"a_key":"a_meta_value_1",
    	"another_key":"a_meta_value_2"
    },
    "details": {
      "message_body": "Welcome to Lagos",
      "message_subject": "A title",
      "sender_name": "A Name",
      "sender_email": "joe@gmail.com"
    }
  }
}

Response 

{
    "status": "Successful",
    "message": "Transaction processed successfully",
    "data": {
        "provider_response_code": "00",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": {
            "reference": "50617644717007",
            "delivery_status": "delivered",
            "cost": "1200",//in kobo
        }
    }
}

Request Payload Description

Field

Type

Requirement

Description

request_ref

string

compulsory

Takes unique value for every request made to OnePipe

request_type

string

compulsory

This should be set to the service get_balance

auth.type

string

compulsory

Depending on the source of fund. This can be set to either bank.account, card, token or wallet

auth.secure

string

compulsory

This is the encrypted value of the source account. Depending on the auth type, this can be either bank account, card details, token or wallet details. See details on how to encrypt the secure field.

auth.provider

string

compulsory

This should be set to the name of the Provider

auth.route_mode

string

N/A

This can be set to null

transaction.mock_mode

string

optional

This can be set to either live or inspect. If left as null, value will fall back to the state of the service set on the console.

transaction.transaction_desc

string

optional

Description of your transaction

transaction.transaction_ref_parent

string

optional

Takes value of a (parent) transaction reference

transaction.customer.customer_ref

string

compulsory

Identifier for customer

transaction.customer.firstname

string

optional

First name of customer

transaction.customer.surname

string

optional

Surname of customer

transaction.customer.email

string

optional

Email address of customer. This is the email address that the message will be delivered to

transaction.customer.mobile_no

string

optional

Phone number of customer

transaction.amount

big int

compulsory

This is the amount (kobo) to be transferred

transaction.transaction_ref

string

compulsory

Takes unique value for every transaction call to OnePipe.

transaction.meta

object

optional

Json object of your arbitrary transaction parameters

transaction.details

object

compulsory

Holds defined fields peculiar to this service

Breakdown of the details object

For this service, the details object will contain the message body and message subject, the email address that will be in the from and the name that would be in the from.

Acceptable values for auth.type

Value

Description

card

Takes card details.

bank.account

Takes bank account.

wallet

Takes a wallet ID for debit.

Possible status response codes

For this service, these are the possible responses a client can receive

Status

Meaning

Successful

Standard success code

Failed

Standard failure code

INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)

Request payload from OnePipe to the provider microservice comes encrypted, using the Triple DES Algorithm. See details.

Request (Transact)

{
  "request_ref":"{{request_ref}}", 
  "request_type":"send_email",
  "auth": {
    "type": "bank.account | card | wallet", 
    "secure": "{{bank account number | card details | wallet}}",
    "auth_provider": "Beeceptor"
  },
  "transaction": {
    "mock_mode": "live", 
    "transaction_ref": "{{transaction_ref}}", 
    "transaction_desc": "A random transaction", 
    "transaction_ref_parent": null, 
    "amount": 0,
    "customer":{
    	"customer_ref": "{{customer_id}}",//recipient
    	"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": {
      "message_body": "Welcome to Lagos",
      "message_subject": "A title",
      "sender_name": "A Name",
      "sender_email": "joe@gmail.com"
    },
    "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": "Victor Motors",
      "id": "5cdab3332b7d4100015f0db4",
      "beneficiary_account_no": "0001137069",
      "extras": {/*this will contain an array of provider override settings*/}
    }
  }
}

Response

{
    "status": "Successful",
    "message": "Transaction processed successfully",
    "data": {
        "provider_response_code": "00",
        "provider": "Beeceptor",
        "errors": null,
        "error": null,
        "provider_response": {
            "reference": "50617644717007",
            "delivery_status": "delivered",
            "cost": "1200",//in kobo
        }
    }
}

Failed Response

In the case of failure or error, the provider should return failure message in this format (encrypted).

{
    "status": "Failed",
    "message": "Operation was not successful",
    "data": {
    	"provider_responde_code":"91",
    	"provider": "Beeceptor",
        "errors": [
          {
            "code" : "01",
            "message : "Reason why it failed"
          }
        ],
        "error": {
          "code" : "01",
          "message : "Reason why it failed"
        },
        "provider_response": {
	       "response_code": "91",
		   "response_message":"Failed"
        }
    }
}

  • No labels