B2B API Specification | North Developer

B2B Payment API

User Management

Get User Details

get /v3/user/self

Returns the user details for the user account tied to the active auth token.

Parameters

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Example Response

200 Successful Response

422 Validation Error

Get Users by Merchant ID

get /v3/users/by-merchant-id/{merchant_id}

Get the user records associated to the given Merchant ID.

Parameters

merchant_id required

integer

name_filter

string

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Example Response

200 Successful Response

422 Validation Error

Update User Password

post /v3/password/change

This method can be used to update a Web User or an API User password. Web user passwords must be changed at least once every 90 days, while API User passwords/tokens do not expire.

Parameters

X-Integrator-Id

string

Maximum:

X-Permalinks

string

Maximum:

Request Schema

password required

string

new_password required

string

Example Request

{
  "password": "string",
  "new_password": "string"
}

Example Response

200 Successful Response

422 Validation Error