Send Password Reset

POST 
/v1/acquirer/merchants/:merchant_id/users/:user_id/password

Generate a password reset token for the user and email them a reset link.

Required permission: merchant_users_password_reset.

Request

Path Parameters

merchant_id stringrequired

Acquirer-assigned merchant identifier (the merchant_id field of the merchant, not its internal UUID).

user_id uuidrequired

Merchant user UUID.

Responses

200

Reset email queued.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "string"
}

Example

{
  "message": "A reset email will be sent to the user shortly."
}

401

Authentication failed.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "Missing authentication information"
}

403

The API key lacks the required permission.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "Unauthorized"
}

404

The referenced resource does not exist or belongs to another acquirer.

application/json

Schema

Schema

message stringrequired

Example (from schema)

{
  "message": "The Order you are looking for was not found."
}

Loading...