Agents


Show a list of agents belonging to this partner

GET /api/v1/partners/:api_token/agents

Return a list of agents created by this partner, sorted by newest first.

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/agents?api_secret=:api_secret

Show an agent belonging to this partner

GET /api/v1/partners/:api_token/agents/:id

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/agents/:id?api_secret=:api_secret

Create a new agent under this partner

POST /api/v1/partners/:api_token/agents

Create a new agent account under this partner. Take note of the ID parameter in the returned Agent hash, it is how you will access this same agent later on.

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/agents?api_secret=:api_secret

{
  agent: {
    name: "Seoul Branch"
  }
}

Request Parameters

NameTypeDescription
agent
required
Value:

Must be a Hash

Agent Information

agent[name]
optional
Value:

Must be String

Name of the Agent


Update the attributes of an agent belonging to this partner

PUT /api/v1/partners/:api_token/agents/:id

Update agent information.

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/agents?api_secret=:api_secret

{
  agent: {
    name: "Incheon Branch"
  }
}

Request Parameters

NameTypeDescription
agent
required
Value:

Must be a Hash

Agent Information

agent[name]
optional
Value:

Must be String

Name of the Agent


Delete an agent belonging to this VENDOR partner

DELETE /api/v1/partners/:api_token/agents/:id

Delete an agent. This will not work if the agent has any users associated with it.