POST /api/v1/partners/:api_token/senders/:sender_id/recipients
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.)
recipient: { first_name: "Luis", last_name: "Buenaventura", email: "luis@bloom.solutions", mobile: "0639175551111", address: "251 Salcedo St., Legaspi Village", city: "Makati City", province: "Metro Manila", country: "PH", }
Name | Type | Description |
---|---|---|
recipient required | Value:
Must be a Hash |
Recipient Information |
recipient[sender_id] required | Value:
Must be a String | |
recipient[first_name] required | Value:
Must be a String | |
recipient[last_name] required | Value:
Must be a String | |
recipient[mobile] required | Value:
Must be a String | |
recipient[email] optional | Value:
Must be a String | |
recipient[address] optional | Value:
Must be a String | |
recipient[city] optional | Value:
Must be a String | |
recipient[state] optional | Value:
Must be a String | |
recipient[country] optional | Value:
Must be one of: | |
recipient[postal_code] optional | Value:
Must be a String | |
recipient[occupation] optional | Value:
Must be a String | |
recipient[birthdate] optional | Value:
Must be a String |
YYYY-MM-DD format |
recipient[identification_type] optional | Value:
Must be a String |
i.e. Driver’s License, Passport |
recipient[identification_number] optional | Value:
Must be a String | |
recipient[identification_details] optional | Value:
Must be a String |
Extra ID details, if any |
Header name | Description |
---|---|
X-API-SECRET required |
API secret of your organization |
GET /api/v1/partners/:api_token/senders/:sender_id/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.
Header name | Description |
---|---|
X-API-SECRET required |
API secret of your organization |
GET /api/v1/partners/:api_token/senders/:sender_id/recipients/:id
Returns Recipient information
Name | Type | Description |
---|---|---|
id required | Value:
Must be a String |
Recipient ID (Integer > 0) |
Header name | Description |
---|---|
X-API-SECRET required |
API secret of your organization |
PUT /api/v1/partners/:api_token/senders/:sender_id/recipients/:id
recipient: { first_name: "Luis", last_name: "Buenaventura", email: "luis@bloom.solutions", mobile: "0639175551111", address: "251 Salcedo St., Legaspi Village", city: "Makati City", province: "Metro Manila", country: "PH" }
Name | Type | Description |
---|---|---|
recipient required | Value:
Must be a Hash |
Recipient Information |
recipient[sender_id] required | Value:
Must be a String | |
recipient[first_name] required | Value:
Must be a String | |
recipient[last_name] required | Value:
Must be a String | |
recipient[mobile] required | Value:
Must be a String | |
recipient[email] optional | Value:
Must be a String | |
recipient[address] optional | Value:
Must be a String | |
recipient[city] optional | Value:
Must be a String | |
recipient[state] optional | Value:
Must be a String | |
recipient[country] optional | Value:
Must be one of: | |
recipient[postal_code] optional | Value:
Must be a String | |
recipient[occupation] optional | Value:
Must be a String | |
recipient[birthdate] optional | Value:
Must be a String |
YYYY-MM-DD format |
recipient[identification_type] optional | Value:
Must be a String |
i.e. Driver’s License, Passport |
recipient[identification_number] optional | Value:
Must be a String | |
recipient[identification_details] optional | Value:
Must be a String |
Extra ID details, if any |
Header name | Description |
---|---|
X-API-SECRET required |
API secret of your organization |
DELETE /api/v1/partners/:api_token/senders/:sender_id/recipients/:id
Safely delete a recipient.
Name | Type | Description |
---|---|---|
id required | Value:
Must be a String |
Header name | Description |
---|---|
X-API-SECRET required |
API secret of your organization |