Kaoshi

Send money abroad, no hassle

STAGING_URL: https://switchapi3.azurewebsites.net
LIVE_URL: https://switchapi.azurewebsites.net

Register Switch User on Kaoshi

POST https://switchapi3.azurewebsites.net/user/kaoshi/register

Registration endpoint

Headers

Name

Type

Description

SWI-CID

string

Client ID

Authorization

string

Format is Bearer token

{
    "message": "User registered successfully on Kaoshi",
    "data": {
        "status": "Success",
        "message": "Sign up completed and wallet created",
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmcmVlQHlhaG9vLmNvbSIsImp0aSI6IjQ5MGUzZjEwLTExNGYtNDRjNC05MjRjLWM5N2ZhMDE5YjJjNiIsImVtYWlsIjoiZnJlZUB5YWhvby5jb20iLCJpZCI6ImY3OGFjNzMyLWE4NzctNGYxMi1hOTVjLTA4ZDdjZmUwOTlkYiIsIm5iZiI6MTU4NTA0Njc4NiwiZXhwIjoxNTg1MDUwMzg2LCJpYXQiOjE1ODUwNDY3ODYsImlzcyI6Imh0dHBzOi8vcGFzcy5zdGVybGluZy5uZy9rYW9zaGkiLCJhdWQiOiJodHRwczovL3Bhc3Muc3Rlcmxpbmcubmcva2Fvc2hpIn0.TomkO3XMr0nZNDrfXTDG6eo3fG7G9tjJHOVsIK-lEuo",
        "userId": "free@yahoo.com",
        "fullName": "EMMANUEL EZE"
    }
}

Get All transactions

GET https://switchapi3.azurewebsites.net/user/kaoshi/transactions

Get All Transactions(exchanges) performed by this user on Kaoshi

Headers

Name

Type

Description

SWI-CID

string

Client ID

Authorization

string

Format is Bearer token

{
    "message": "Transactions loaded successfully",
    "data": {
        "status": "Success",
        "message": [
            {
                "id": "115",
                "transaction_id": "tx-p4og3yrd3w",
                "userId": "ginger@yahoo.com",
                "account_number": "0072279974",
                "amount": 32000,
                "destination_bank_code": "000001",
                "destination_account_number": null,
                "status": "Success",
                "datecreated": "2020-03-19T07:36:33.3245026"
            },
            {
                "id": "114",
                "transaction_id": "tx-0zqd2z2dk3",
                "userId": "ginger@yahoo.com",
                "account_number": "0072279974",
                "amount": 32100,
                "destination_bank_code": "000001",
                "destination_account_number": null,
                "status": "Success",
                "datecreated": "2020-03-18T10:33:48.3914287"
            },
            {
                "id": "108",
                "transaction_id": "tx-7z0gryndx9",
                "userId": "ginger@yahoo.com",
                "account_number": "0072279974",
                "amount": 34500,
                "destination_bank_code": "000001",
                "destination_account_number": null,
                "status": "Success",
                "datecreated": "2020-03-05T15:43:02.1542633"
            },
            {
                "id": "107",
                "transaction_id": "tx-nw2dq8jdpj",
                "userId": "ginger@yahoo.com",
                "account_number": "0072279974",
                "amount": 32200,
                "destination_bank_code": "000001",
                "destination_account_number": null,
                "status": "Success",
                "datecreated": "2020-03-05T15:40:43.660897"
            },
            {
                "id": "106",
                "transaction_id": "tx-748epyqe5x",
                "userId": "ginger@yahoo.com",
                "account_number": "0072279974",
                "amount": 32100,
                "destination_bank_code": "000001",
                "destination_account_number": null,
                "status": "Success",
                "datecreated": "2020-03-05T15:28:45.7922824"
            },
            {
                "id": "93",
                "transaction_id": "tx-npoe7zjg0w",
                "userId": "ginger@yahoo.com",
                "account_number": null,
                "amount": 1000,
                "destination_bank_code": null,
                "destination_account_number": null,
                "status": "Pending",
                "datecreated": "2020-03-02T10:12:19.3154078"
            },
            {
                "id": "92",
                "transaction_id": "tx-03mg6z9e1n",
                "userId": "ginger@yahoo.com",
                "account_number": null,
                "amount": 1200,
                "destination_bank_code": null,
                "destination_account_number": null,
                "status": "Pending",
                "datecreated": "2020-03-02T08:17:56.0889505"
            },
            {
                "id": "76",
                "transaction_id": "tx-vq5ejz2g0p",
                "userId": "ginger@yahoo.com",
                "account_number": "0072279974",
                "amount": 1200,
                "destination_bank_code": "000001",
                "destination_account_number": null,
                "status": "Success",
                "datecreated": "2020-02-21T12:35:51.1039067"
            },
            {
                "id": "74",
                "transaction_id": "tx-npoe7kjg0w",
                "userId": "ginger@yahoo.com",
                "account_number": "0072279974",
                "amount": 1200,
                "destination_bank_code": "000001",
                "destination_account_number": null,
                "status": "Success",
                "datecreated": "2020-02-21T10:14:20.3297456"
            },
            {
                "id": "72",
                "transaction_id": "tx-k64d5x0ej0",
                "userId": "ginger@yahoo.com",
                "account_number": null,
                "amount": 1200,
                "destination_bank_code": null,
                "destination_account_number": null,
                "status": "Pending",
                "datecreated": "2020-02-21T10:00:42.1311714"
            },
            {
                "id": "64",
                "transaction_id": "tx-poldw64ezn",
                "userId": "ginger@yahoo.com",
                "account_number": null,
                "amount": 1200,
                "destination_bank_code": null,
                "destination_account_number": null,
                "status": "Pending",
                "datecreated": "2020-02-20T08:41:56.7510396"
            },
            {
                "id": "60",
                "transaction_id": "tx-4v9e1zmgz8",
                "userId": "ginger@yahoo.com",
                "account_number": null,
                "amount": 1200,
                "destination_bank_code": null,
                "destination_account_number": null,
                "status": "Pending",
                "datecreated": "2020-02-13T12:28:38.1636902"
            },
            {
                "id": "59",
                "transaction_id": "tx-7w6g00kg9m",
                "userId": "ginger@yahoo.com",
                "account_number": null,
                "amount": 1200,
                "destination_bank_code": null,
                "destination_account_number": null,
                "status": "Pending",
                "datecreated": "2020-02-13T12:25:53.2906668"
            }
        ]
    }
}

Verify Dollar Recipient

POST https://switchapi3.azurewebsites.net/user/kaoshi/verify_recipient

Verify dollar recipient

Headers

Name

Type

Description

SWI-CS

string

Payload checksum

SWI-CID

string

Client ID

Authorization

string

Format is Bearer token

Request Body

Name

Type

Description

userHandle

string

recipient email

{
    "message": "Found User",
    "data": {
        "firstname": "usd",
        "lastname": "beneficiary",
        "handle": "usd-beneficiary@example.com"
    }
}

Get Kaoshi Wallet Balance

GET https://switchapi3.azurewebsites.net/user/kaoshi/wallet_balance

Get wallet balance

Headers

Name

Type

Description

SWI-CID

string

Client ID

Authorization

string

Format is Bearer token

{
    "message": "Wallet balance retrieved successfully",
    "data": {
        "status": 1,
        "balance": 38187.5
    }
}

Validate Account Number

GET https://switchapi3.azurewebsites.net/user/kaoshi/validate_account_number

validate funding account number, should happen before user is asked to enter OTP

Headers

Name

Type

Description

SWI-CID

string

Client ID

Authorization

string

Format is Bearer token

{
    "message": "Account Number is Valid",
    "data": {
        "status": 1,
        "message": "Successful"
    }
}

Get Kaoshi User

GET https://switchapi3.azurewebsites.net/user/kaoshi/user

Get the Kaoshi User

Headers

Name

Type

Description

SWI-CID

string

Client ID

Authorization

string

Format is Bearer token

Get Exchange Rates

GET https://switchapi3.azurewebsites.net/user/kaoshi/rates

Headers

Name

Type

Description

SWI-CID

string

Client ID

Authorization

string

Format is Bearer token

{
    "message": "Rates retrieved successfully",
    "data": {
        "min": 320,
        "max": 350,
        "fee_percentage": 2.5
    }
}

Create Exchange Offer

POST https://switchapi3.azurewebsites.net/user/kaoshi/create_offer

Create offer to exchange Naira for USD

Headers

Name

Type

Description

SWI-CS

string

Payload checksum

SWI-CID

string

Client ID

Authorization

string

Format is Bearer token

Request Body

Name

Type

Description

otp

string

6-digit OTP

current_account_balance

string

"280.5"

exchange_rate

string

"320"

matcher_amount

string

"100"

poster_amount

number

e.g 3200

recipient_username

string

eg. usd-beneficiary@example.com

PreviousLimits NextPayment Link

Last updated 5 years ago

Was this helpful?