Authorize merchant
This method is used to establish a connection with the BridgerPay system.
POST /auth/loginContent-Type: application/json{"user_name": "{{user_name}}","password": "{{password}}"}
postLogin
post
<URL>/auth/login
This method is used to establish a connection with the BridgerPay system.
Request
Response
Request
Headers
Content-Type
required
string
Data format to present information in the response; only "application/json" is supported
Body Parameters
user_name
required
string
Merchant's username; provided by BridgerPay
password
required
string
Merchant's password; provided by BridgerPay
Response
200: OK
Successful response
{"response": {"status": "OK", //Response status"code": 200, //Response code"message": "OK" //Comment associated with the response},"result": {"access_token": {"token": "<AUTH_TOKEN>", //JWT token"expires_in": 7200 //Period within which the token is valid, in secs},"refresh_token": "","permissions": { //Entities the token gives access to"dashboard.access": true,"reports.access": true,"reports.preview": true,"reports.export": true,"cashier.access": true,"cahiers.edit": true,"transactions.access": true,"transactions.refund": true,"bridger_router.access": true,"bridger_router.edit": true,"payment_provider.access": true,"virtual_terminal.access": true},"roles": [ //Roles the token grants"Admins"]}
403: Forbidden
1) Attempt to connect to a wrong environment
2) Attempt to log in using an incorrect username, password, or both
{"response": {"status": "Forbidden","code": 403,"message": "login_failure"},"result": [{"type": "login_failure","field": "user_name","message": "Invalid user-name or password."}]}
415: Unsupported Media Type
Content-Type header parameter has not been provided, or the specified value is not supported by BridgerPay (empty response)
