Login

ipaymy uses JWT for authentication.

First and foremost, You will need to call our authentication endpoint with the appropriate payload to generate an Bearber token, which you'll include in subsequent calls to our endpoints. If it would like to revoke your existing token and generate a new one, you simply can call our authentication endpoint again.

Request

Request header:

POST https://api.ipaymy.com/v2/login
Host: api.ipaymy.com
Accept: application/json

Request body:

{
  "email": "example@ipaymy.com",
  "password": "ipaymy",
  "client_id": 1
}

email:

  • Type: string
  • Validate: required

password:

  • Type: string
  • Validate: required

client_id:

  • Type: number
  • Validate: required

Response

Response body:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb3IiOjQwMCwidWlkIjo1NTc4MywidiI6IjF8MzM2MDIzfDU1NzgzfF98MXwxfDF8MXw4MnwxfDF8MXxffDJ8MjI5MTk4fDB8In0.30Ol9kB4L-2IE4aEct_uMQCSSSsRY6rRfna-kHGmnuw",
  "int_pay_reminder_notification": false
}

token:

  • Description: Attach this bearer token to every request header
  • Type: string

Response codes:

  • 200: Good stuff, and the response body should be easy to parse.
  • 422: Typically malformed JSON, such as an integer in place of the required alphanumeric string, or a missing key. Check the response body for further details.

There you go. Now you can access any of our APIs with this access token.

← RegisterPassword reset →