GET /api/v1/rates
UNAUTHENTICATED: Returns a real-time hash of currency exchange rates. Updates every 1 minute.

Our supported currencies include PHP, USD, CAD, JPY, AUD, SGD, HKD, KRW, CNY, EUR, VND, SAR, TWD, QAR, KWD, AED, GBP, MYR, INR, IDR, LKR, BTC. By default, all rates provided are relative to Bitcoin.

If you wish to receive rates relative to a different currency, use /rates?currency=USD.

Examples

{
  USD: 1,
  PHP: 45.32,
  BTC: 0.0026630534
}

Params

Param name Description
currency
optional

3-Letter Currency Name

Validations:

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


GET /api/v1/schedule
UNAUTHENTICATED: Returns a hash regarding our current fulfillment capabilities.

Due to the fact that we are not currently operational 24/7, it becomes necessary to check fulfillment capabilities prior to initiating a remittance. Our operating hours as of September 2014 are 9am-5pm Mondays through Sundays, Philippines time.

If a given remittance is initiated and paid for outside of office hours, it will be processed on the next working day.


GET /api/v1/strategies
UNAUTHENTICATED: Lists Remittance Strategies

Returns a JSON nested array of valid remittance strategies and corresponding slugs. The strategies are grouped by type ('bank', 'pickup', etc), and then further broken down by provider. The slug is used to indicate which provider a remittance is meant to be paid out with.

Examples

bank: [
  { name: 'Allied Bank',  slug: 'ABC' },
  { name: 'BDO',          slug: 'BDO' },
  { name: 'BPI',          slug: 'BPI' },
],
pickup: [
  { name: 'Cebuana Lhuillier', slug: 'CLH' },
  { name: 'Palawan Express',   slug: 'PAL' }
]

GET /api/v1/provinces
UNAUTHENTICATED: Lists Philippine provinces alphabetically

The Philippines is divided into 90 provinces, each of which are further divided into cities and towns. Fulfillment providers sometimes price their services differently depending on which province or region a remittance is bound for, so in the interest of transparency, we have provided a list of Philippine provinces that external apps can copy and display as dropdown menus in their forms.

It's a good idea to cache this information, as this data is largely static.

Examples

["Abra", "Agusan del Norte", "Agusan del Sur", "Aklan", "Albay", "Angeles", "Antique", "Apayao", "Aurora", "Baguio", "Basilan", "Bataan", "Batanes", "Batangas", "Benguet", "Biliran", "Bohol", "Bukidnon", "Bulacan", "Cagayan", "Camarines Norte", "Camarines Sur", "Camiguin", "Capiz", "Catanduanes", "Cavite", "Cebu", "Compostela Valley", "Cotabato", "Dagupan", "Davao Occidental", "Davao Oriental", "Davao del Norte", "Davao del Sur", "Dinagat Islands", "Eastern Samar", "Guimaras", "Ifugao", "Ilocos Norte", "Ilocos Sur", "Iloilo", "Isabela", "Kalinga", "La Union", "Laguna", "Lanao del Norte", "Lanao del Sur", "Leyte", "Lucena", "Maguindanao", "Marinduque", "Masbate", "Metro Manila", "Mindoro Occidental", "Mindoro Oriental", "Misamis Occidental", "Misamis Oriental", "Mountain Province", "Naga", "Negros Occidental", "Negros Oriental", "Northern Samar", "Nueva Ecija", "Nueva Vizcaya", "Olongapo", "Palawan", "Pampanga", "Pangasinan", "Puerto Princesa", "Quezon", "Quirino", "Rizal", "Romblon", "Samar", "Santiago", "Sarangani", "Siquijor", "Sorsogon", "South Cotabato", "Southern Leyte", "Sultan Kudarat", "Sulu", "Surigao del Norte", "Surigao del Sur", "Tarlac", "Tawi-Tawi", "Zambales", "Zamboanga", "Zamboanga del Norte", "Zamboanga del Sur"]

GET /api/v1/provinces_by_region
UNAUTHENTICATED: Lists Philippine provinces by region

Returns a nested list of Philippine provinces, grouped into super-regions (Luzon, Visayas, Mindanao), and then by regions (Region I, II, III, etc). Most Filipinos will be more familiar with the province that a given city belongs to rather than its region number, so a more appropriate list to display is the one generated by the preceeding /provinces call.

It's a good idea to cache this information, as this data is largely static.