All information about the given remittance and recipient are returned with this call. Important fields to note include status_in_words and payment_details.

Status_in_words changes from its initial value of pending to successful when we have confirmed blockchain payment. It changes to completed when we have handed off the local currency to the chosen fulfillment partner. It could in very rare occasions also be marked partial if the sender only sends partial payment and thus leaves the invoice address unpaid. (If the sender eventually adds the remaining balance, we will change the status to successful accordingly.)

Vendors using the API can also trigger a change of status to cancelled by using the /delete method. This safely removes the transaction from our processing queue.

Lastly, it could be rejected if we detect abuse or are otherwise unable to complete the rebittance. In this case, we will include an explanation in the 'rejection_message' field.

With every status change, we will POST an updated JSON object of the remittance record to your provided callback_url, if any. This JSON object will usually contain a payment_details which lists network confirmations and relevant addresses, if these are available.

Supported Formats

json

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"
  }
}

Params

Param name Description
id
required

Remittance ID (Integer > 0)

Validations:

  • Must be a String