POST /api/v1/recipients
USERS: Create a new recipient. START HERE when initiating a new money transfer.

Initiate a new money transfer by first creating a recipient. You may optionally supply a remittance hash to automatically build a remittance associated with this new recipient.

Generally, you want to reuse recipient records whenever you can, as this allows us to build a transaction history for a given person. However, there are plenty of instances when simply creating a new recipient record would be more appropriate, even when it pertains to the previously-created record and email address. (An example would be if the recipient is in a different province, which means that we would need to calculate a different service fee for him/her anyway.)

Examples

recipient: {
  first_name: "Luis",
  last_name:  "Buenaventura",
  email:      "luis@sci.ventures",
  mobile:     "0639175551111",
  address:    "251 Salcedo St., Legaspi Village",
  city:       "Makati City",
  province:   "Metro Manila"
}

Params

Param name Description
recipient
required

Recipient Information

Validations:

  • Must be a Hash

recipient[first_name]
required

Validations:

  • Must be a String

recipient[last_name]
required

Validations:

  • Must be a String

recipient[mobile]
required

Validations:

  • Must be a String

recipient[email]
optional

Validations:

  • Must be a String

recipient[address]
optional

Validations:

  • Must be a String

recipient[city]
optional

Validations:

  • Must be a String

recipient[province]
optional

Validations:

  • Must be a String

recipient[postal_code]
optional

Validations:

  • Must be a String


GET /api/v1/recipients
USERS: List all recipients

List all recipients associated with the current user, paginated via [:page] parameter. Note that there are no uniqueness checks for recipient names, emails, or mobiles, so you will need to build your own methods for organizing them.


GET /api/v1/recipients/:id
USERS: Show details about a recipient and their associated remittance(s)

Recipients may have multiple remittances associated with them, and it's up to the developer to structure their data accordingly.

Params

Param name Description
id
required

Recipient ID (Integer > 0)

Validations:

  • Must be a String


PUT /api/v1/recipients/:id
USERS: Update recipient attributes

Examples

recipient: {
  first_name: "Luis",
  last_name:  "Buenaventura",
  email:      "luis@sci.ventures",
  mobile:     "0639175551111",
  address:    "251 Salcedo St., Legaspi Village",
  city:       "Makati City",
  province:   "Metro Manila"
}

Params

Param name Description
recipient
required

Recipient Information

Validations:

  • Must be a Hash

recipient[first_name]
required

Validations:

  • Must be a String

recipient[last_name]
required

Validations:

  • Must be a String

recipient[mobile]
required

Validations:

  • Must be a String

recipient[email]
optional

Validations:

  • Must be a String

recipient[address]
optional

Validations:

  • Must be a String

recipient[city]
optional

Validations:

  • Must be a String

recipient[province]
optional

Validations:

  • Must be a String

recipient[postal_code]
optional

Validations:

  • Must be a String


DELETE /api/v1/recipients/:id
USERS: Delete recipient record safely

Safely delete a recipient from being displayed as a member of your user's child recipient. We never delete records so you will still be able to retrieve any removed recipients by querying for them directly.

Params

Param name Description
id
required

Recipient ID (Integer > 0)

Validations:

  • Must be a String