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

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