API Documentation

Recipients

Create a new recipient for a sender belonging to this partner.

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.)

Examples

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",
}

Request Parameters

NameTypeDescription
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: TJ, JM, HT, ST, MS, AE, PK, NL, LU, BZ, IR, BO, UY, GH, SA, CI, MF, TF, AI, QA, SX, LY, BV, PG, KG, GQ, EH, NU, PR, GD, KR, HM, SM, SL, CD, MK, TR, DZ, GE, PS, BB, UA, GP, PF, NA, BW, SY, TG, DO, AQ, CH, MG, FO, VG, GI, BN, LA, IS, EE, UM, LT, RS, MR, AD, HU, TK, MY, AO, CV, NF, PA, GW, BE, PT, GB, IM, US, YE, HK, AZ, CC, ML, SK, VU, TL, HR, SR, MU, CZ, PM, LS, WS, KM, IT, BI, WF, GN, SG, CO, CN, AW, MA, FI, VA, ZW, KY, BH, PY, EC, LR, RU, PL, OM, MT, SS, DE, TM, SJ, MM, TT, IL, BD, NR, LK, UG, NG, BQ, MX, CW, SI, MN, CA, AX, VN, TW, JP, IO, RO, BG, GU, BR, AM, ZM, DJ, JE, AT, CM, SE, FJ, KZ, GL, GY, CX, MW, TN, ZA, TO, CY, MV, PN, RW, NI, KN, BJ, ET, GM, TZ, VC, FK, SD, MC, AU, CL, DK, FR, TC, CU, AL, MZ, BS, NE, GT, LI, NP, BF, PW, KW, IN, GA, TV, MO, SH, MD, CK, AR, SC, IE, ES, LB, BM, RE, KI, AG, MQ, SV, JO, TH, SO, MH, CG, KP, GF, BA, YT, GS, KE, PE, BT, SZ, CR, TD, DM, NC, GR, GG, HN, VI, CF, SN, AF, MP, PH, BY, LV, NO, EG, KH, IQ, LC, NZ, BL, UZ, ID, ER, VE, FM, SB, ME, AS.

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

Headers

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

List all recipients for a user belonging to this partner.

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.

Headers

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

Show details about a recipient of a given user, and their associated remittance IDs

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

Returns Recipient information

Request Parameters

NameTypeDescription
id
required		Value:

Must be a String

Recipient ID (Integer > 0)

Headers

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

Update the attributes of a recipient of a user belonging to this partner.

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

Examples

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"
}

Request Parameters

NameTypeDescription
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: TJ, JM, HT, ST, MS, AE, PK, NL, LU, BZ, IR, BO, UY, GH, SA, CI, MF, TF, AI, QA, SX, LY, BV, PG, KG, GQ, EH, NU, PR, GD, KR, HM, SM, SL, CD, MK, TR, DZ, GE, PS, BB, UA, GP, PF, NA, BW, SY, TG, DO, AQ, CH, MG, FO, VG, GI, BN, LA, IS, EE, UM, LT, RS, MR, AD, HU, TK, MY, AO, CV, NF, PA, GW, BE, PT, GB, IM, US, YE, HK, AZ, CC, ML, SK, VU, TL, HR, SR, MU, CZ, PM, LS, WS, KM, IT, BI, WF, GN, SG, CO, CN, AW, MA, FI, VA, ZW, KY, BH, PY, EC, LR, RU, PL, OM, MT, SS, DE, TM, SJ, MM, TT, IL, BD, NR, LK, UG, NG, BQ, MX, CW, SI, MN, CA, AX, VN, TW, JP, IO, RO, BG, GU, BR, AM, ZM, DJ, JE, AT, CM, SE, FJ, KZ, GL, GY, CX, MW, TN, ZA, TO, CY, MV, PN, RW, NI, KN, BJ, ET, GM, TZ, VC, FK, SD, MC, AU, CL, DK, FR, TC, CU, AL, MZ, BS, NE, GT, LI, NP, BF, PW, KW, IN, GA, TV, MO, SH, MD, CK, AR, SC, IE, ES, LB, BM, RE, KI, AG, MQ, SV, JO, TH, SO, MH, CG, KP, GF, BA, YT, GS, KE, PE, BT, SZ, CR, TD, DM, NC, GR, GG, HN, VI, CF, SN, AF, MP, PH, BY, LV, NO, EG, KH, IQ, LC, NZ, BL, UZ, ID, ER, VE, FM, SB, ME, AS.

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

Headers

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

Delete recipient record of a user belonging to this partner safely

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

Safely delete a recipient.

Request Parameters

NameTypeDescription
id
required		Value:

Must be a String

Headers

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