...
The provider microservice should have it's own way of taking money from the auth details passed in, then execute the transfer to the destination account supplied. 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:
OnePipe
Host client
ISO
Settlement & fees model
Model | How it works |
|---|---|
Amount or Commission | Provider sends a share of income to the settlement account at the host; which will then be shared with OnePipe, host and ISO. |
...
| Info |
|---|
For details on encryption using the Triple DES Algorithm, read this. |
Request (Transact)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"transfer_funds",
"auth": {
"type": "bank.account | card | wallet",
"secure": "{{encrypted(bank account details | card details | wallet)}}",
"auth_provider": "Beeceptor",
"route_mode": null
},
"transaction": {
"mock_mode": "live",
"transaction_ref": "{{transaction_ref}}",
"transaction_desc": "A random transaction",
"transaction_ref_parent": null,
"amount": 1000,
"customer":{
"customer_ref": "{{customer_id}}",
"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": {
"destination_account":"2363262632",
"destination_bank_code":"011"
}
}
} |
Response (when otp_override = false)
| Code Block | ||
|---|---|---|
| ||
{
"status": "WaitingForOTP",
"message": "Please enter the OTP sent to 2348022****08",
"data": {
"provider_response_code": "900T0",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": null
}
} |
Response (when otp_override = true)
| Code Block | ||
|---|---|---|
| ||
{
"status": "Successful",
"message": "Transaction processed successfully",
"data": {
"provider_response_code": "00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"reference": "000022200225154318222333334432",
"payment_id": "136FTTP200590171",
"destination_institution_code": "000016",
"beneficiary_account_name": "JOHN DOE JAMES",
"beneficiary_account_number": "3056433222",
"beneficiary_kyc_level": "3",
"originator_account_name": "James Jane",
"originator_account_number": "0001131256",
"originator_kyc_level": "1",
"narration": "My narration",
"transaction_final_amount": 1000,
"meta":{
"field_key":"field_value",
"field_key":"field_value"
}
}
}
} |
Request (validate with otp)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"transfer_funds",
"auth": {
"secure": "{{encrypted_otp}}",
"auth_provider": "Beeceptor"
},
"transaction": {
"transaction_ref": "70713093460718"
}
} |
...
Breakdown of the details object
For this service, the details object will have the following:
Field | Type | Requirement | Description | |
|---|---|---|---|---|
requestdestination_account_refnumber | string | compulsory | Takes unique value for every request made to OnePipe | request_typeDestination account to send funds to |
destination_bank_code | string | compulsory | This should be set to the service | |
auth.type | string | compulsory | Depending on the source of fund. This can be set to either | |
auth.secure | string | compulsory | This is the encrypted value of the source of fund. 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 | |
transaction.mock_mode | string | optional | This can be set to either | |
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 | |
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 have the following:
...
Field
...
Type
...
Requirement
...
Description
...
destination_account_number
...
string
...
compulsory
...
Destination account to send funds to
...
destination_bank_code
...
string
...
compulsory
...
Destination institution code
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
...
WaitingForOTP
...
To signify that this provider has requested an OTP from the customer and it should be supplied.
...
PendingValidation
...
To signify that this provider needs some extra information to be provided. The response.message will contain the prompt.
INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)
| Info |
|---|
Request payload from OnePipe to the provider microservice comes encrypted, using the Triple DES Algorithm. See details. |
Request (Transact)
| Code Block | ||
|---|---|---|
| ||
{
"request_ref":"{{request_ref}}",
"request_type":"transfer_funds",
"auth": {
"type": "bank.account | card | wallet",
"secure": "{{bank account details | card details | wallet}}",
"auth_provider": "Beeceptor"
},
"transaction": {
"mock_mode": "live",
"transaction_ref": "{{transaction_ref}}",
"transaction_desc": "A random transaction",
"transaction_ref_parent": null,
"amount": 1000,
"customer":{
"customer_ref": "{{customer_id}}",
"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": {
"destination_account":"2363262632",
"destination_bank_code":"011"
},
"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 (when otp_override = false)
Set provider_response_code to 900T0
| Code Block | ||
|---|---|---|
| ||
{
"status": "WaitingForOTP",
"message": "Please enter the OTP sent to 2348022****08",
"data": {
"provider_response_code": "900T0",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": null
}
} |
Response (when otp_override = true)
| Code Block |
|---|
{
"status": "Successful",
"message": "Operation was successful",
"data": {
"provider_responde_code":"00",
"provider": "Beeceptor",
"errors": null,
"error": null,
"provider_response": {
"reference": "000022200225154318222333334432",
"payment_id": "136FTTP200590171",
"destination_institution_code": "000016",
"beneficiary_account_name": "JOHN DOE JAMES",
"beneficiary_account_number": "3056433222",
"beneficiary_kyc_level": "3",
"originator_account_name": "James Jane",
"originator_account_number": "0001131256",
"originator_kyc_level": "1",
"narration": "My narration",
"transaction_final_amount": 1000,
"meta":{
"field_key":"field_value",
"field_key":"field_value"
}
}
}
} |
Failed Response
| Code Block |
|---|
{
"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",
"meta":{
"field_key":"field_value",
"field_key":"field_value"
}
}
}
} |
Request (validate with otp)
...
| language | json |
|---|
...
Destination institution code |
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 |
WaitingForOTP | To signify that this provider has requested an OTP from the customer and it should be supplied. |
PendingValidation | To signify that this provider needs some extra information to be provided. The |
Acceptable values for auth.type
card
bank.account
wallet
voucher
INTERFACE SPECIFICATION (ONEPIPE → PROVIDER MICRO SERVICE)
| Info |
|---|
Request payload from OnePipe to the provider microservice comes encrypted, using the Triple DES Algorithm. See details. |
Read this closely.
Special notes for OTP override
...