Supported Formats

json

Errors

Code Description
404 Couldn't find a recipient record with that ID
500 Please check your provided rebittance attributes carefully

Examples

{
  "id": 38,
  "status": "completed",
  "status_in_words": "completed",
  "processing_fee": 0.0,
  "processing_fee_in_btc": 0.0,
  "service_fee": 0.0,
  "service_fee_in_btc": 0.0,
  "invoice_address_with_amount": "bitcoin:3MGXng4B6DrbnCYunmxCs5ayHxUrEsjt3S?amount=0.08112778",
  "completed_at": "2018-03-13T16:10:31.663+08:00",
  "created_at": "2018-03-06T13:47:44.324+08:00",
  "succeeded_at": null,
  "remittance_details": {
    "pickup": "HQ"
  },
  "amount": 523.0,
  "currency": "USD",
  "amount_in_btc": 0.08112778,
  "total": 523.0,
  "total_in_btc": 0.08112778,
  "effective_rate": "329680.0",
  "effective_rates": {
    "PHP": 329680.0,
    "USD": 6446.62
  },
  "destination_amount": "523.0",
  "destination_currency": "USD",
  "source_amount": "0.08112778",
  "source_currency": "BTC",
  "destination": "$523.00",
  "source": "B⃦0.08112778",
  "recipient": {
    "id": 64,
    "first_name": "Juan",
    "middle_name": null,
    "last_name": "dela Cruz",
    "email": "juan@delacruz.com",
    "mobile": "+63 (123) 123-1231",
    "created_at": "2018-03-06T13:47:44.229+08:00"
  },
  "user": {
    "id": 1,
    "first_name": "Test",
    "last_name": "User",
    "email": "test@user.com"
  },
  "manual_transaction": false
}

Params

Param name Description
recipient_id
required

Recipient ID

Validations:

  • Must be a String

remittance
required

Remittance instructions

Validations:

  • Must be a Hash

remittance[amount]
required

Remittance amount (Ex. 1000.00)

Validations:

  • Must be a String

remittance[currency]
required

Remittance amount currency code (Ex. 'USD', 'PHP', 'BTC', 'JPY')

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.

remittance[strategy]
required

Remittance strategy slug

Validations:

  • Must be one of: pickup, bank, bills, eload.

remittance[callback_url]
optional

URL to post updates to when remittance status changes

Validations:

  • Must be a String

remittance[remittance_details]
required

Remittance details

Validations:

  • Must be a Hash

remittance[remittance_details][bank]
optional

Bank Name, if strategy is 'bank'. See the /delivery_methods call for list of Code-Name mappings

Validations:

  • Must be one of: ABC, ASB, AUB, BDO, BPI, BFS, BOA, BOC, CBS, CBC, CCB, CTS, CIT, CIS, EWB, EWR, EQC, HBP, HSB, LBP, MSB, MAY, MET, PBC, PNB, PNS, PSB, PAC, PVB, PTC, PPB, RCB, RSB, RBN, SBS, SEC, SCB, SBA, USB, UCP, UBP, YSB.

remittance[remittance_details][bank_account_type]
optional

Bank Account Type, if strategy is 'bank'

Validations:

  • Must be one of: PHP Savings, PHP Checking.

remittance[remittance_details][bank_account_name]
optional

Bank Account Name, if strategy is 'bank'

Validations:

  • Must be a String

remittance[remittance_details][bank_account_number]
optional

Bank Account No., if strategy is 'bank'

Validations:

  • Must be a String

remittance[remittance_details][delivery]
optional

Delivery provider name, if strategy is 'delivery'. See the /delivery_methods for list Code-Name mappings

Validations:

  • Must be one of: LBCPP.

remittance[remittance_details][pickup]
optional

Pickup provider name, if strategy is 'pickup'. See the /delivery_methods for list of Code-Name mappings

Validations:

  • Must be one of: CLH, MLH, PAL.

remittance[remittance_details][bills]
optional

Merchant or Provider name, if strategy is 'bills'. See the /providers call for more information.

Validations:

  • Must be one of: aig, acc, allied, ateneo, axa, banco, bankard, bayantel, british, cdc, cebupac, chinatrust, latter, citicard, citiloan, citifin, city, cosmo, dbtc, dlsg, dlsz, destiny, digitel, direc, eastern, eastwest, easy, equi, febc, fgf, first, fortcare, fortlife, globe, great, grepa, hsbc, , info, innove, ios, ipm, manilamem, manilawater, manuchina, manufin, manuphil, maynilad, meralco, metro, miriam, mmo, mydestiny, nation, nso, opsmile, pagibighl, pagibigmp2, pagibigreg, papf, paramount, philam, pioneer, piso, planet, pldt, pnb, pncc, prime, prude, psloan, pt, redcross, blind, rockwell, sbdiner, sbmc, sbcash, sky, smart, sssff, sssnw, sssofw, sssself, sssvol, scloan, sccard, subic, union, usjr, ue, veco, world.

remittance[remittance_details][bill_due_date]
optional

Bill's due date, if strategy is 'bills

Validations:

  • Must be a String

remittance[remittance_details][bill_period_from]
optional

Bill's starting period, if strategy is 'bills

Validations:

  • Must be a String

remittance[remittance_details][bill_period_to]
optional

Bill's ending period, if strategy is 'bills

Validations:

  • Must be a String