Yogupay
  • Welcome!
  • Getting Started
    • Signing Up
    • Onboarding Process
    • Environments
    • Compliance
      • Documents Required
      • Terms & Conditions
      • Licenses
      • Privacy Policy
  • Business Dashboard
    • Login
    • Dashboard
    • View Balances
    • Add Money (Deposit)
    • Adding a Beneficiary
    • Send Money
    • Swap Currencies
    • Whitelist your IPs
    • Viewing Transactions
  • Developers
    • Authentication
    • API response codes
    • 🏦Bank Codes
    • 💱Currency Codes
    • View Account Balances
    • View All Transactions
    • Get Transaction By ID
    • 🌍Payout Africa
      • 🇬🇭Payout Ghana
      • 🇰🇪Payout Kenya
      • 🇳🇬Payout Nigeria
        • Verify Bank Account NGN
      • 🇺🇬Payout Uganda
      • 🇨🇲Payout Cameroon
      • 🇨🇮Payout Ivory Coast
    • 🌎Payout LATAM
Powered by GitBook
On this page
  • Auth Login
  • Request and Response Example
  1. Developers

Authentication

This endpoint is used to authenticate a user and obtain a token for accessing protected resources.

PreviousViewing TransactionsNextAPI response codes

Last updated 22 days ago

Before authenticating , ensure you White list your IP before hand using the

Auth Login

POST /auth/login

The POST request is used to authenticate and login to YoguPay. Credentials are provided to business accounts by YoguPay

Headers

Name
Value

Content-Type

application/json

Token

token

The token to be used above will be obtained from the response (expires after 30minutes requires a refresh)

Body

Name
Type
Description

username

string

User name of the user

password

string

Password of the user

Request and Response Example

{
  "password": "1",
  "username": "user@yogupay.com"
}

{
    "status": "1",
    "message": "Login successful",
    "image": "https://tumapay.com/tp/images/avatar.png",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTAwOTAsInVzZXJuYW1lIjoiZXJyb2xAeW9ndXBheS5jb20iLCJlbnZpcm9ubWVudCI6InN0YWdpbmciLCJpcF9hZGRyZXNzIjoiOjpmZmZmOjQxLjkwLjExNi4xNjEiLCJpYXQiOjE3MzAxMDU2MTAsImV4cCI6MTczMDEwNzQxMH0.HP9SGLNJsXW7DgGK0AYq6CYJjTc1YXLQbRekxK-dsR8",
    "username": "user@yogupay.com",
    "is_verified": 1,
    "country_code": "GB",
    "phone_number": 254712345678,
    "full_name": "Demo Account",
    "number_of_transactions": 0
}


{
    "status": "0",
    "message": "Invalid Login Details"
}

The token obtained from the response above will be used to authenticate subsequent pages

Whitelist IP Guide