API Documentation

Payments

Initiate a bill payment

POST /api/v2/payments

Supported Formats

json

Errors

404 - Couldn't find a recipient record with that ID
422 - Request was correctly parsed but there is missing information

Examples

# Example URL

http://www.bloomremit.net/api/v2/payments

# Example request

{
  "api_token": "cKaB99a0",
  "api_secret": "t9spJmEu4",
  "payment" : {
    "account_name": "Luis Buenaventura",
    "account_number": "1234567890",
    "callback_url": "http://yourwebsite.com/callback_for_bloom",
    "dest_currency": "PHP",
    "flat_fee_in_orig_currency": 3000,
    "forex_margin": 0.5,
    "orig_currency": "KRW",
    "paid_in_orig_currency": 15000,
    "payout_method": "PLDT",
    "receivable_in_dest_currency": 500
  }
}

# Example 200 (successful) response
{
  "payment": {
    "id": "fa672cc7-6006-46e6-9e64-14ac412cb2a4",
    "teller_id": "c2002ad1-7618-4592-b868-409ab209fdcf",
    "orig_currency": "KRW",
    "dest_currency": "PHP",
    "paid_in_orig_currency": 15000.0,
    "receivable_in_dest_currency": 500.0,
    "status": "incomplete",
    "payout_method": "PLDT",
    "partner_id": "049902b7-f09e-4675-a835-76df30017b94",
    "flat_fee_in_orig_currency": 3000.0,
    "forex_margin": 0.0,
    "account_name": "Luis Buenaventura",
    "account_number": "1234567890",
    "callback_url": "http://yourwebsite.com/callback_for_bloom",
    "sender_id": "d96f181e-d106-410d-86e0-2c91306dc97f"
  }
}

# Example 422 (error) response when sender is not given

{
  "errors": [ "Sender is blank" ]
}

Request Parameters

NameTypeDescription
api_token
required		Value:

Must be a String

Your API token

api_secret
required		Value:

Must be a String

Your API secret

sender_id
required		Value:

Must be a String

Sender ID that is paying for this bill

payment
required		Value:

Must be a Hash

Remittance instructions

payment[orig_currency]
required		Value:

Must be one of: AED, AUD, BTC, CAD, CNY, EUR, GBP, HKD, IDR, INR, JPY, KRW, KWD, MYR, NGN, NPR, NZD, PHP, QAR, SAR, SGD, TWD, USD, VND.

Currency of Origin (Ex. ‘USD’, ‘KRW’)

payment[paid_in_orig_currency]
required		Value:

Must be a Float

Amount paid by customer (Ex. 20000.00)

payment[flat_fee_in_orig_currency]
optional		Value:

Must be a Float

Flat service fee that you wish to add to the total bill of your sender. Leave this blank to use your default fee (if any).

payment[forex_margin]
optional		Value:

Must be a Float

Additional foreign-exchange percentage to add to the total bill of your sender. Leave this blank to use your default margin (if any).

payment[dest_currency]
required		Value:

Must be one of: AED, AUD, BTC, CAD, CNY, EUR, GBP, HKD, IDR, INR, JPY, KRW, KWD, MYR, NGN, NPR, NZD, PHP, QAR, SAR, SGD, TWD, USD, VND.

Currency of Destination

payment[receivable_in_dest_currency]
optional		Value:

Must be a Float

Amount received by recipient (Ex. 1000.00). This is computed automatically and may be left blank

payment[payout_method]
required		Value:

Must be one of: PLARIDEL_WATER, NOCECO, MediCard, BIR, LIPA_BANK, QUEZELCO2, PANELCO3, METROBANK, ISELCO1, PILI_WATER, PAMI_INSURANCE, SHAMA_BROADBAND_AND_CATV, ILAGAN_WATER, TREND_CATV, EAGLE_VISION_INC, EXCEL_CABLE, TREND_CABLE, EAGLE_VISION_CATV, ACOM, SANAGUSTINREALTY_SANCDEPAZ, SIMBAYANAN_COOP, BULACAN_WATER, FUSE_LENDING, OBANDO_WATER, PEZA, TIEZA, SAN_AGUSTIN_REALTY(SANCDEPAZ), BACIWA, CASURECO2, ANGELES_WATER, ROBINSONSBANK_CREDITCARD, CONNEXT_MARKETING, HONEYCOMB, SAJELCO, PANELCO1, GRAB, SOUTH_LUZON_CATV, JMD_CABLE_NETWORK, LOAN_STAR, BICORE, AIRYOUGO_TRAVELS, OLM_LENDING, iCASH_EXPRESS, BROADBAND_EVERYWHERE, RFC_LOAN, QUICKPERA, GLOBAL_DOMINION, ZAMECO1, BENECO, STA_MARIA_WATER, TARLAC_CABLE, STA_LUCIA_REALTY, NEECO2_AREA1, PRC, NORKIS, INSULAR_SAVERS, ZAMECO2, BP_WATERWORKS, RS_PROPERTY, OPTIMUM_BANK, FLECO, VECO, CAVITE_CABLE, NSOHELPLINE.COM, PLUS_CABLE, BATELEC2, ICONNEX, CABLE_TELEVISION, PAYEXPRESS, CEBUPACIFIC, HM_CATV, CENTRAL_LUZON_CABLE, G-NET, PAWNONE, CDO_WATER, COMCLARK, LIMA_ENERZONE, MANILAWATER, PLDT, CEBECO2, CALUMPIT_WATER, METRO_FASTBET, MYCLOUD, SMART, GOODHANDS_WATER, MCWD, CANORECO, COTABATO_LIGHT, ENTERPRISEBANK_LOAN, PRIMECAST_CABLE, PELCO1, AXA_PHIL, NORTHSTAR_CABLE, PESOPAY, GLOBALLAND, MAYNILAD, DFA, LAGUNAWATER, HOME_LIPA_CABLE, NEECO2_AREA2, PLANET_CABLE, TARELCO2, SKYCABLE, SUNCELLULAR, PELCO2, SANCLEMENTE_CABLE, VIACOM, SORSOGON_WATER, DRAGONPAY, NBI, MET_CABLE, CONVERGE_ICT, CARISSA, PROMO_ECPROTECT, BPI_CREDITCARD, GLOBELINES, BATELEC1, LAGUNA_WATER_DISTRICT, BAYANTEL, UNISTAR, VERDANT_CABLE, FINASWIDE, PENELCO, BRIGHTMOON_CABLE, PILIPINO_CABLE, PHILSMILE, POEA, ISLA_CABLE, ABS_MOBILE, PELCO3, CIGNAL, GOLDEN_HAVEN, PRESCO, PAL, CABLELINK, COCOLIFE, ISECO, PARAMOUNT, PRIMEWATER, SUBURBAN_CABLE, INEC, FIRST_PEAK, HITECH_CABLE, GATE, ILECO1, HAPPYWELL, MAYBRIDGE, ASIALINK, MFI_LENDING, RMG, ROYALCABLE, ANGELES_CABLE, DASURECO, AEON_CREDIT, AUB_CREDITCARDS, AIRASIA, CELESTIAL_MEADOWS, SKYJET, OEDC, MABALACAT_WATER, TABACO_WATER, JMY_ADVANTAGE, SOUTH_ASIALINK, HOME_CREDIT, LEISURE_WORLD, DIGITEL, SUMISHO, SUBIC_ENERZONE, ANGELES_ELECTRIC, CHINATRUST, DAVAOLIGHT, GOLDEN_EAGLE_CABLE, SITELCO, GHPHONE, DIBBLE.

Biller slug (Ex. PLDT)

payment[account_name]
required		Value:

Must be a String

Account identifier with the biller (Ex. Phone number)

payment[account_number]
required		Value:

Must be a String

Account number with the biller (Ex. Customer number)

payment[callback_url]
optional		Value:

Must be a String

URL to post updates to when the status of a remittance changes. Please respond with a HTTP Code 200 and the word ‘ok’. If you have a Callback URL already defined in the Partner Settings, this is unnecessary.

payment[external_id]
required		Value:

Must be a String

The ID that the bills payment service provider will track. Must be unique