This returns a new Remittance JSON object, with an invoice_address (ex. 1kNzb1394aama0de) and a total_in_btc amount (ex. 1.15604).

In order to complete this remittance, you will need to send an amount matching total_in_btc to the provided invoice address within 30 minutes.

Use the callback_url method to specify a URL to send status updates to. The payload includes the entire Remittance JSON object, similar to the Remittances#show method. This is useful if you want to be instantly notified when a given remittance has been confirmed on the blockchain, completed, canceled, or rejected. We will attempt to send a given status-update message from our API up to a maximum of 25 times. The period in between retries increase at an exponential rate, and all attempts to send a given message terminate automatically after 5 days. Your server must return a plain-text “OK” response along with a status 200 in order to cancel subsequent attempts.

Errors

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

Examples

recipient_id: 1,
remittance: {
  amount:   10000.00,
  currency: 'PHP',
  strategy: 'bank',
  callback_url: "http://yourwebsite.com/remittances/1/callback_for_rebit",
  remittance_details: {
    bank:                 'ABC',
    bank_account_type:    'Peso Savings',
    bank_account_number:  '12345678',
    bank_account_name:    'Luis Buenaventura'
  }
}
recipient_id: 1,
remittance: {
  amount:   10000.00,
  currency: 'PHP',
  strategy: 'pickup',
  callback_url: "http://yourwebsite.com/remittances/1/callback_for_rebit",
  remittance_details: {
    pickup: 'CLH'
  }
}

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, mobile, bank, delivery, bills, eload.

remittance[callback_url]
optional

URL to post updates to when remittance status changes. The payload includes the entire Remittance JSON object, similar to the Remittances#show method.

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 /providers call for more information.

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'. If bank account is not local currency, an additional forex fee may apply.

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 /providers call for more information.

Validations:

  • Must be one of: LBCPP.

remittance[remittance_details][pickup]
optional

Pickup provider name, if strategy is 'pickup'. See the /providers call for more information.

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