GoodFunds Gateway - RESTful API Documentation

Users

Users are the accounts in which can access all services in Secure Vault System.

GET users

List all users associated with your company.

    Resource Information

  • Method: GET
  • URL: https://demo.goodfundsgateway.com/api/users.json
  • Requires authentication? Yes

Method Parameters

N/A

Query Parameters

Parameter Type Required Description
active string N (default) : Will show all users
"1" : Will Show all active users
"0" : Will Show all non active users

Response data: (json format)

      {
        "status": "success",
        "successMessage": {
          "response_code": 315,
          "message": {
            "users": [
              {
                "id": "1",
                "client_id": "[Client ID]",
                "rights_id": "[Rights ID]",
                "username": "[Username]",
                "secret_key": "[API Key]",
                "email": "[Email]",
                "created_on": "[Created On Date]",
                "last_login": "[Last Login Date]",
                "active": "[Active 1 or 0]",
                "first_name": "[First Name]",
                "last_name": "Last Name",
                "company": "Company Name",
                "phone": "[Phone Number]"
              }
            ]
          }
        }
      }
    

POST user

Creates a user under your associated company.

    Resource Information

  • Method: POST
  • URL: https://demo.goodfundsgateway.com/api/user.json
  • Requires authentication? Yes

Method Parameters

N/A

Query Parameters

Parameter Type Required Description
first_name string Y Joe
last_name string Y Smith
company string Y John Smith's Body Shop
phone string Y 1-555-555-0000 | (555) 555-5555 | 555-555-5555 | 555.555.5555
email string Y A valid email address for the client.
username string Y Unique username for user.
password string Y User password.
Must be at least 6 digits length
Can have Upper & Lower Case
Can be auto generated but can't be empty
password_confirm string Y Must match password field

Response data: (json format)

      {
        "status": "success",
        "successMessage": {
          "response_code": 310,
          "message": {
            "user": {
              "user_id": [Unique User ID]
            }
          }
        }
      }
    

GET user/{userId}

Get details of a specific user by ID.

    Resource Information

  • Method: GET
  • URL: https://demo.goodfundsgateway.com/api/user.json/{userId}
  • Requires authentication? Yes

Method Parameters

Parameter Type Required Description
userId int Y Specific user by ID that is being requested.

Query Parameters

Parameter Type Required Description
active string N (default) : Will show the specific user regardless if active or not
"1" : Will show only if user is active
"0" : Will show only if user is not active

Response data: (json format)

      {
        "status": "success",
        "successMessage": {
          "response_code": 315,
          "message": {
            "user": {
              "id": "1",
              "client_id": "[Client ID]",
              "rights_id": "[Rights ID]",
              "username": "[Username]",
              "secret_key": "[API Key]",
              "email": "[Email]",
              "created_on": "[Created On Date]",
              "last_login": "[Last Login Date]",
              "active": "[Active 1 or 0]",
              "first_name": "[First Name]",
              "last_name": "[Last Name]",
              "company": "[Company Name]",
              "phone": "[Phone Number]"
            }
          }
        }
      }
    

POST user/{userId}/update

Update details of a specific user by ID.

    Resource Information

  • Method: POST
  • URL: https://demo.goodfundsgateway.com/api/user.json/{userId}/update
  • Requires authentication? Yes

Method Parameters

Parameter Type Required Description
userId int Y Specific user by ID to be updated.

Query Parameters

Parameter Type Required Description
first_name string N Joe
last_name string N Smith
company string N John Smith's Body Shop
phone string N 1-555-555-0000 | (555) 555-5555 | 555-555-5555 | 555.555.5555
password string N User password.
Must be at least 6 digits length
Can have Upper & Lower Case
Can be auto generated but can't be empty

Response data: (json format)

      {
        "status": "success",
        "successMessage": {
          "response_code": 311,
          "message": "Updated"
        }
      }
    

POST user/{userId}/activate

Activate a specific user by ID.

    Resource Information

  • Method: POST
  • URL: https://demo.goodfundsgateway.com/api/user.json/{userId}/activate
  • Requires authentication? Yes

Method Parameters

Parameter Type Required Description
userId int Y Specific user by ID to be activate.

Query Parameters

N/A

Response data: (json format)

      {
        "status": "success",
        "successMessage": {
          "response_code": 313,
          "message": "User Activated"
        }
      }
    

POST user/{userId}/deactivate

Deactivate a specific user by ID.

    Resource Information

  • Method: POST
  • URL: https://demo.goodfundsgateway.com/api/user.json/{userId}/deactivate
  • Requires authentication? Yes

Method Parameters

Parameter Type Required Description
userId int Y Specific user by ID to be deactivated.

Query Parameters

N/A

Response data: (json format)

      {
        "status": "success",
        "successMessage": {
          "response_code": 314,
          "message": "User Deactivated"
        }
      }
    

POST user/{userId}/delete

Deletes or removes a specific user.

    Resource Information

  • Method: POST
  • URL: https://demo.goodfundsgateway.com/api/user.json/{userId}/delete
  • Requires authentication? Yes

Method Parameters

Parameter Type Required Description
userId int Y Specific user which will be deleted or removed.

Query Parameters

N/A

Response data: (json format)

        {
          "status": "success",
          "successMessage": {
            "response_code": 312,
            "message": "User Deleted"
          }
        }