Skip to content

Latest commit

 

History

History
182 lines (145 loc) · 7.02 KB

doc.md

File metadata and controls

182 lines (145 loc) · 7.02 KB

SDK Scheme Adapter and WSO2 API Gateway

This documentaion is for testing scheme adapter against a public hosted WSO2 API gateway with SSL encryption and bearer token authentication.

Overview

Prerequisite

  • Accesss to WSO2 API production api with a generated token.
  • sdk-scheme-adapter
  • mojaloop-simulator

Generate and get access token and URL from WSO2 API

  • Login to your WSO2 store and go to applications in the menu. Create a new application and access keys if you don't have those already.
  • Then go to APIs menu, you should find the following applications. Subscribe to these two APIs by selecting your application and tier from the each API main page.
    • Central Ledger Admin API - We will use this endpoint for creating a new fsp and configure endpoints for that fsp
    • FSPIOP API - This is the main API for account lookup, quotes & transfers
  • You can try some api requests in "API Console" tab by selecting the generated access token.
  • Please make a note of the API URLs for both APIs and access token.

Arrange a public IP, DNS name and trusted SSL certificate

For getting back the responses, we need a machine with static public IP. A domain name should be registered and get SSL certificate for that domain name from a trusted CA.

You need to get CA certificate, server certificate and server private key to configure in our scheme adapter.

If you want to try this on an aws EC2 instance and with letsencrypt certificate, please follow this link.

Setting up Scheme Adapter with Mojaloop Simulator

Please download the Mojaloop Simulator repo

git clone https://github.com/mojaloop/mojaloop-simulator.git

  • Generate the certicates by running the script "scripts/createSecrets.sh". This will generate certificates in src/secrets folder. Then replace the server cert, server key and ca cert from the above step.

    Incase of any certificate issues you may need to disable the "rejectUnauthorized" setting in "sdk-scheme-adapter" source code and re-build the docker image.

  • Edit the file src/docker-compose.yml and change the required parameters. Please refer the following file.

    mojaloop-simulator_files/docker-compose.yml

  • Edit the file src/sim-backend.env file and change the container name of the scheme adapter in that. Please refer the following file.

    mojaloop-simulator_files/sim-backend.env

  • Edit the file src/scheme-adapter.env and change the following settings

    MUTUAL_TLS_ENABLED=true
CACHE_HOST=src_redis_1
DFSP_ID=extpayerfsp
BACKEND_ENDPOINT=src_sim_1:3000
PEER_ENDPOINT=<Your WSO2 api url>
AUTO_ACCEPT_QUOTES=true

    Please see the following file for your reference and add/change required lines if needed.

    mojaloop-simulator_files/scheme-adapter.env

    You may need to add the following line if there is no proper SSL certificate for WSO2 gateway.

    NODE_TLS_REJECT_UNAUTHORIZED=0

Then try running the following command to run the services

cd src/
docker-compose up -d

We can now access the mojaloop simulator's test api on 3003.

Provision a new DFSP "extpayerfsp" with proper endpoints

We should create a new fsp named "extpayerfp" or with any other name.

The FSP onboarding section in "OSS-New-Deployment-FSP-Setup" postman collection can be used for this. You can get the postman repo from https://github.com/mojaloop/postman.

  • Duplicate the "Mojaloop-Local" environment and change the following valuesin that
    • payerfsp - extpayerfsp
    • HOST_ML_API_ADAPTER, HOST_ML_API, HOST_SWITCH_TRANSFERS, HOST_ACCOUNT_LOOKUP_SERVICE, HOST_QUOTING_SERVICE - Your WSO2 FSPIOP API endpoint
    • HOST_CENTRAL_LEDGER - Your WSO2 Central Services Admin API endpoint
    • HOST_CENTRAL_SETTLEMENT - Your WSO2 Central Settlement API endpoint (optional for our testing)
    • HOST_SIMULATOR & HOST_SIMULATOR_K8S_CLUSTER - https://<your_domain_name>:4000
  • Change the URLs in payerfsp onboarding in "FSP Onboarding" section of "OSS-New-Deployment-FSP-Setup" from "payerfsp" to "extpayerfsp"
  • Change the authentication as "Bearer Token" and provide the access token we created in WSO2 store for the entire "Payer FSP Onboarding" folder.
  • Then run the "Payer FSP Onboarding" folder in that collection with the newly created environment.

You should get 100% pass then we can confirm that the fsp is created and endpoints are set for the fsp.

Provision payeefsp and register a participant agains MSISDN simulator

Generally the simulator conatins payeefsp and you should register a new participant (phone number) of your choice.

You can refer the postman request "p2p_happy_path SEND QUOTE / Register Participant {{pathfinderMSISDN}} against MSISDN Simulator for PayeeFSP" in "Golden_Path" collection to achieve this.

The postman request will send a POST request to <HOST_ACCOUNT_LOOKUP_SERVICE>/participants/MSISDN/<new_phone_number> with the following body and required http headers.

{
    "fspId": "payeefsp",
    "currency": "USD"
}

Send money

In one step

If you want to send the money in one step, the configuration options "AUTO_ACCEPT_QUOTES" & "AUTO_ACCEPT_PARTY" in "scheme_adapter.env" should be enabled.

curl -X POST \
  "http://localhost:3003/scenarios" \
  -H 'Content-Type: application/json' \
  -d '[
    {
        "name": "scenario1",
        "operation": "postTransfers",
        "body": {
            "from": {
                "displayName": "From some person name",
                "idType": "MSISDN",
                "idValue": "44123456789"
            },
            "to": {
                "idType": "MSISDN",
                "idValue": "919848123456"
            },
            "amountType": "SEND",
            "currency": "USD",
            "amount": "100",
            "transactionType": "TRANSFER",
            "note": "testpayment",
            "homeTransactionId": "123ABC"
        }
    }
]'

In two steps

The following command is used to send the money in two steps (i.e Requesting the quote first, accept after review the charges and party details)

curl -X POST \
  "http://localhost:3003/scenarios" \
  -H 'Content-Type: application/json' \
  -d '[
    {
        "name": "scenario1",
        "operation": "postTransfers",
        "body": {
            "from": {
                "displayName": "From some person name",
                "idType": "MSISDN",
                "idValue": "44123456789"
            },
            "to": {
                "idType": "MSISDN",
                "idValue": "9848123456"
            },
            "amountType": "SEND",
            "currency": "USD",
            "amount": "100",
            "transactionType": "TRANSFER",
            "note": "testpayment",
            "homeTransactionId": "123ABC"
        }
    },
    {
        "name": "scenario2",
        "operation": "putTransfers",
        "params": {
            "transferId": "{{scenario1.result.transferId}}"
        },
        "body": {
            "acceptQuote": true
        }
    }
]'