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
api_secret
required
Value:

Must be String

Partner API Secret

recipient
required
Value:

Must be a Hash

Recipient Information

recipient[sender_id]
required
Value:

Must be String

recipient[first_name]
required
Value:

Must be String

recipient[last_name]
required
Value:

Must be String

recipient[mobile]
required
Value:

Must be String

recipient[email]
optional
Value:

Must be String

recipient[address]
optional
Value:

Must be String

recipient[city]
optional
Value:

Must be String

recipient[state]
optional
Value:

Must be String

recipient[country]
optional
Value:

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

recipient[postal_code]
optional
Value:

Must be String


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.


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 String

Recipient ID (Integer > 0)


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
api_secret
required
Value:

Must be String

Partner API Secret

recipient
required
Value:

Must be a Hash

Recipient Information

recipient[sender_id]
required
Value:

Must be String

recipient[first_name]
required
Value:

Must be String

recipient[last_name]
required
Value:

Must be String

recipient[mobile]
required
Value:

Must be String

recipient[email]
optional
Value:

Must be String

recipient[address]
optional
Value:

Must be String

recipient[city]
optional
Value:

Must be String

recipient[state]
optional
Value:

Must be String

recipient[country]
optional
Value:

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

recipient[postal_code]
optional
Value:

Must be String


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 String