Bloom Remit - API documentation

API Documentation

Getting Started

Senders

Show a list of senders belonging to this partner

GET /api/v1/partners/:api_token/senders

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

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/senders

Headers

Header name	Description
X-API-SECRET required	API secret of your organization

Show a user belonging to this partner

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

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/senders/:id

Headers

Header name	Description
X-API-SECRET required	API secret of your organization

Show a sender belonging to this partner by supplying their email address

GET /api/v1/partners/:api_token/senders/find_by_email

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/senders/find_by_email?email=helloluis%40me.com
(Don't forget to escape the email string!)

Headers

Header name	Description
X-API-SECRET required	API secret of your organization

Show a sender belonging to this partner by supplying their mobile

GET /api/v1/partners/:api_token/senders/find_by_mobile

For best results, format your mobile number like this: +639178881111

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/senders/find_by_mobile?mobile=+639178329098
(Don't forget to escape the plus symbol!)

Headers

Header name	Description
X-API-SECRET required	API secret of your organization

Create a new user under this partner

POST /api/v1/partners/:api_token/senders

Create a new user account under this partner. This returns a 8-character randomly-generated password that you may pass on to your user or store for later use. (The password is not required in order to send remittances.)

Take note of the ID parameter in the returned User hash, it is how you will access this same user later on.

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/senders

{
  agent_id: "12345-54321",
  sender: {
    first_name: "Luis",
    last_name:  "Buenaventura",
    email:      "luis@www.bloomremit.net",
    mobile:     "+639175551111",
    address:    "251 Salcedo St., Legaspi Village",
    city:       "Makati City",
    country:    "PH",
    postal_code: "1600",
    identification: {
      url: "http://aws.amazon.com/bucket/image.jpg"
    }
  }
}

Request Parameters

Name	Type	Description
agent_id optional	Value: Must be a String	The id of the Agent that this user belongs to. If you don’t include this, we will automatically assign this user to the first Agent record that belongs to this partner.
sender required	Value: Must be a Hash	Sender Information
sender[first_name] required	Value: Must be a String	First name
sender[last_name] required	Value: Must be a String	Last name
sender[email] required	Value: Must be a String
sender[mobile] required	Value: Must be a String	Mobile number
sender[address] optional	Value: Must be a String	Residential address
sender[city] optional	Value: Must be a String	City
sender[country] required	Value: Must be a String	Country
sender[postal_code] optional	Value: Must be a String
sender[identification] optional	Value: Must be a Hash
sender[identification][url] optional	Value: Must be a String	URL string pointing to a static image of the user’s passport, driver’s license, or other government-issued ID. (Ex. http ://aws.amazon.com/image.jpg)
sender[proof_of_address] optional	Value: Must be a Hash
sender[proof_of_address][url] optional	Value: Must be a String	URL string pointing to a static image of the user’s utility bill, bank statement, or other third-party-issued document with residential address prominently indicated. (Ex. http ://aws.amazon.com/image.jpg)
sender[birthdate] optional	Value: Must be a String	Birthdate.

Headers

Header name	Description
X-API-SECRET required	API secret of your organization

Update the attributes of a user belonging to this partner

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

Update user profile information. Note that a user’s email address is not editable. When changing a user’s password, use the /senders/:id/update_password call.

Examples

https://www.bloomremit.net/api/v1/partners/:api_token/senders

{
  user: {
    first_name: "Luis",
    last_name:  "Buenaventura",
    mobile:     "+639175551111",
    address:    "251 Salcedo St., Legaspi Village",
    city:       "Makati City",
    country:    "PH",
    postal_code: "1600",
    identification: {
      url: "http://aws.amazon.com/bucket/image.jpg"
    }
  }
}

Request Parameters

Name	Type	Description
user required	Value: Must be a Hash	User Information
user[first_name] optional	Value: Must be a String	First name; defaults to ‘Guest’
user[last_name] optional	Value: Must be a String	Last name; defaults to ‘Customer’
user[email] optional	Value: Must be a String	Email
user[mobile] optional	Value: Must be a String	Mobile number
user[address] optional	Value: Must be a String	Residential address
user[city] optional	Value: Must be a String	City
user[country] optional	Value: Must be a String	Country
user[postal_code] optional	Value: Must be a String
user[identification] optional	Value: Must be a Hash
user[identification][url] optional	Value: Must be a String	URL string pointing to a static image of the user’s passport, driver’s license, or other government-issued ID. This is required for sending limits above PhP50,000.00 (Ex. http://aws.amazon.com/image.jpg)
user[proof_of_address] optional	Value: Must be a Hash
user[proof_of_address][url] optional	Value: Must be a String	URL string pointing to a static image of the user’s utility bill, bank statement, or other third-party-issued document with residential address prominently indicated. This is required for sending limits above PhP150,000.00 (Ex. http://aws.amazon.com/image.jpg)
user[birthday] optional	Value: Must be a String	Birthdate. This is required for sending limits above PhP150,000.00 (Ex. http://aws.amazon.com/image.jpg)

Headers

Header name	Description
X-API-SECRET required	API secret of your organization

Delete a sender belonging to this partner

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

Safely delete a user. This will also cascade down to the sender’s recipients.

Headers

Header name	Description
X-API-SECRET required	API secret of your organization