Transactions

Transactions will be the main API endpoint you’ll be interacting with. Make remittances/payments to different banks, remittance centers, and other institutions via this endpoint.

Use the following endpoint to get updates on the transactions. See this POST call:

curl -X POST 'https://www.bloomremit.net/message-bus/x/poll?dlp=t' -H 'Authorization: Basic MTox' -d %2Fv2%2Ftx_events=-50
  • MTox is your partner_id:partner_api_secret in base64 without newlines or spaces.
  • %2Fv2%2Ftx_events or /v2/tx_events is set to -50 in the example, and this will return the last 49 events.

You may use https://github.com/SamSaffron/message_bus if you’re in Ruby, JS, or if you want to learn more.

Here’s a sample response:

[
  {
    "global_id": 68510299,
    "message_id": 10385646,
    "channel": "/v2/tx_events",
    "data": [
      {
        "id": "1baa3dc9-f474-45a1-9386-88ce131801d5",
        "recipient_id": "fe630d66-4624-42ab-9ae5-4f811be7c1ae",
        "dest_currency": "PHP",
        "receivable_in_dest_currency": 1000,
        "payout_method": "CLH",
        "status": "waiting",
        "account_name": "Michael Jordan",
        "account_number": "0292881777",
        "tracking_sender": "Chase Patrol",
        "tracking_number": "BLMKAMLUWAH",
        "client_external_id": "ca479519-0949-4062-9109-5f8fd88d47f8",
        "purpose": "Help",
        "sender_first_name": "Chase",
        "sender_last_name": "Patrol",
        "sender_email": "chase@pawpatrol.com",
        "sender_address": "1 Lookout",
        "sender_city": "Adventure Bay",
        "sender_state": "Adventure State",
        "sender_zip_code": "12323",
        "sender_country": "Adventure Country",
        "sender_occupation": "Rescue pup",
        "recipient_first_name": "Michael",
        "recipient_last_name": "Jordan",
        "recipient_email": "michael@jordan.org",
        "recipient_mobile": "09191234567",
        "recipient_address": "21 Jump St",
        "recipient_city": "Washington City",
        "recipient_state": "WA",
        "recipient_zip_code": "12345",
        "recipient_country": "USA",
        "recipient_occupation": "Baseball player",
        "recipient_relationship_to_sender": "Idol",
        "orig_currency": "BTC",
        "paid_in_orig_currency": 0.21
      }
    ]
  }
]

Headers

Header name Description
X-API-PARTNER-ID
required
Your organization's ID
X-API-SECRET
required
API secret of your organization

Get transaction information

GET /api/v2/txns/:id

Examples

{
  "id": "295848e2-3d38-4179-8ac8-f40e1e03c511",
  "recipient_id": "c989b5d3-04bd-480d-bc68-b42605c435e3",
  "dest_currency": "PHP",
  "receivable_in_dest_currency": 1000,
  "payout_method": "CLH",
  "status": "waiting",
  "account_name": "Michael Jordan",
  "account_number": "0292881777",
  "tracking_sender": "Chase Patrol",
  "tracking_number": "BLMKAMLUWAH",
  "client_external_id": "c49fc6f0-b939-4176-857b-6ba0b8459465",
  "purpose": "Help",
  "sender_first_name": "Chase",
  "sender_last_name": "Patrol",
  "sender_email": "chase@pawpatrol.com",
  "sender_address": "1 Lookout",
  "sender_city": "Adventure Bay",
  "sender_state": "Adventure State",
  "sender_zip_code": "12323",
  "sender_country": "Adventure Country",
  "sender_occupation": "Rescue pup",
  "recipient_first_name": "Michael",
  "recipient_last_name": "Jordan",
  "recipient_email": "michael@jordan.org",
  "recipient_mobile": "09191234567",
  "recipient_address": "21 Jump St",
  "recipient_city": "Washington City",
  "recipient_state": "WA",
  "recipient_zip_code": "12345",
  "recipient_country": "USA",
  "recipient_occupation": "Baseball player",
  "recipient_relationship_to_sender": "Idol",
  "orig_currency": "BTC",
  "paid_in_orig_currency": 0.21
}

Request Parameters

NameTypeDescription
id
required
Value:

Must be a String


Create transactions

POST /api/v2/txns

Examples

Sample response:
{
  "txn": {
    "id": "0e5f46fe-3513-465c-bf06-4a761c3a18c3",
    "recipient_id": "453b97b4-7c96-4eff-bea2-b22642bdca34",
    "dest_currency": "PHP",
    "receivable_in_dest_currency": 1000,
    "payout_method": "CLH",
    "status": "waiting",
    "account_name": "Michael Jordan",
    "account_number": "0292881777",
    "tracking_sender": "Chase Patrol",
    "tracking_number": "BLMKAMLUWAH",
    "client_external_id": "82e1b295-6d17-497c-9de5-63a5a8914f41",
    "purpose": "Help",
    "sender_first_name": "Chase",
    "sender_last_name": "Patrol",
    "sender_email": "chase@pawpatrol.com",
    "sender_address": "1 Lookout",
    "sender_city": "Adventure Bay",
    "sender_state": "Adventure State",
    "sender_zip_code": "12323",
    "sender_country": "Adventure Country",
    "sender_occupation": "Rescue pup",
    "recipient_first_name": "Michael",
    "recipient_last_name": "Jordan",
    "recipient_email": "michael@jordan.org",
    "recipient_mobile": "09191234567",
    "recipient_address": "21 Jump St",
    "recipient_city": "Washington City",
    "recipient_state": "WA",
    "recipient_zip_code": "12345",
    "recipient_country": "USA",
    "recipient_occupation": "Baseball player",
    "recipient_relationship_to_sender": "Idol",
    "orig_currency": "BTC",
    "paid_in_orig_currency": 0.21
  }
}

Request Parameters

NameTypeDescription
txn
required
Value:

Must be a Hash

txn[sender_first_name]
required
Value:

Must be a String

txn[sender_last_name]
required
Value:

Must be a String

txn[sender_email]
optional
Value:

Must be a String

Required if no mobile is provided

txn[sender_mobile]
optional
Value:

Must be a String

Required if no email is provided. Include country code, i.e. +639172119087

txn[sender_address]
optional
Value:

Must be a String

Street address of sender. Required if depositing to a bank account.

txn[sender_city]
required
Value:

Must be a String

txn[sender_state]
required
Value:

Must be a String

State/province of the sender

txn[sender_zip_code]
optional
Value:

Must be a String

Required if depositing to a bank account

txn[sender_country]
required
Value:

Must be a String

txn[sender_occupation]
required
Value:

Must be a String

txn[recipient_first_name]
required
Value:

Must be a String

txn[recipient_last_name]
required
Value:

Must be a String

txn[recipient_email]
optional
Value:

Must be a String

Required if recipient mobile is blank

txn[recipient_mobile]
optional
Value:

Must be a String

Include country code, i.e. +639172119087; required if recipient email is blank

txn[recipient_address]
optional
Value:

Must be a String

Street address of recipient. Required if depositing to a bank account.

txn[recipient_city]
required
Value:

Must be a String

txn[recipient_state]
required
Value:

Must be a String

State/province of the recipient

txn[recipient_zip_code]
optional
Value:

Must be a String

Required if depositing to a bank account

txn[recipient_country]
required
Value:

Must be a String

txn[recipient_occupation]
required
Value:

Must be a String

txn[recipient_relationship_to_sender]
required
Value:

Must be a String

‘Father’ if recipient is the father of the sender

txn[dest_currency]
required
Value:

Must be a String

ISO 4217 currency code that Bloom and the payout method supports, i.e. PHP

txn[receivable_in_dest_currency]
required
Value:

Must be a String

Amount the recipient is to receive

txn[payout_method]
required
Value:

Must be a String

Bank/remittance center where this will be sent. See /developers/1/static

txn[purpose]
required
Value:

Must be a String

txn[account_number]
optional
Value:

Must be a String

Only for bank deposits

txn[account_name]
optional
Value:

Must be a String

Only for bank deposits

txn[client_external_id]
required
Value:

Must be a String

Unique ID that you use to refer to this transaction

txn[orig_currency]
optional
Value:

Must be a String

Origin currency (tracking purposes only)

txn[paid_in_orig_currency]
optional
Value:

Must be a String

Origin currency amount (tracking purposes only)