{"docs":{"name":"Bloom","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"/developers/2","api_url":"/api","resources":{"credits":{"doc_url":"/developers/2/credits","id":"credits","api_url":"/api","name":"Credits","short_description":null,"full_description":null,"version":"2","formats":null,"metadata":null,"methods":[{"doc_url":"/developers/2/credits/history","name":"history","apis":[{"api_url":"/api/v2/credits/history","http_method":"GET","short_description":"Show a list of credit transactions","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eGrab a list of the most recent 100 credit transactions associated with this vendor account. Transactions that add to your credit will are positive, and transactions that use up your credit (i.e., to pay for remittances) will be negative.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["[\n  {\n    \"target_currency\" : \"PHP\",\n    \"target_amount\" : \"1000.0\",\n    \"balance\" : \"44000.0\",\n    \"created_at\" : \"2016-09-07T09:53:02.686+08:00\",\n    \"description\" : null,\n    \"id\" : 2,\n    \"invoice_address\" : null,\n    \"item_id\" : null,\n    \"item_type\" : null,\n    \"partner_id\" : \"0a711ec2-aa0a-4249-a327-0dea6ecc2467\",\n    \"rate\" : \"1.0\",\n    \"source_amount\" : \"1000.0\",\n    \"source_currency\" : \"PHP\",\n    \"transaction_hash\" : null,\n    \"updated_at\" : \"2016-09-07T09:53:02.686+08:00\"\n  },\n  {\n    \"target_currency\" : \"PHP\",\n    \"target_amount\" : \"45000.0\",\n    \"balance\" : \"45000.0\",\n    \"created_at\" : \"2016-09-07T09:53:02.678+08:00\",\n    \"description\" : null,\n    \"id\" : 1,\n    \"invoice_address\" : null,\n    \"item_id\" : null,\n    \"item_type\" : null,\n    \"partner_id\" : \"0a711ec2-aa0a-4249-a327-0dea6ecc2467\",\n    \"rate\" : \"45.0\",\n    \"source_amount\" : \"1000.0\",\n    \"source_currency\" : \"USD\",\n    \"transaction_hash\" : null,\n    \"updated_at\" : \"2016-09-07T09:53:02.678+08:00\"\n  }\n]\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-PARTNER-ID","description":"Your organization's ID","options":{"required":true}},{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"exchange_rates":{"doc_url":"/developers/2/exchange_rates","id":"exchange_rates","api_url":"/api","name":"Exchange rates","short_description":null,"full_description":null,"version":"2","formats":null,"metadata":null,"methods":[{"doc_url":"/developers/2/exchange_rates/index","name":"index","apis":[{"api_url":"/api/v2/exchange_rates","http_method":"GET","short_description":"AUTHENTICATED: Returns a real-time hash of supported currency pairs. Updates every minute.","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eOur supported currencies include ADA, AED, AUD, AXS, BCH, BNB, BTC, BUSD, CAD, CNY, DASH, ETH, EUR, GBP, HKD, IDR, INR, JPY, KRW, LINK, LTC, MYR, NEAR, NPR, PAX, PHP, SGD, SLP, THB, USD, USDC, USDT, VND, XLM, XRP, ZAR. By default, all rates provided are relative to PHP.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["https://www.bloomremit.net/api/v2/exchange_rates\n\n{\n  \"PHPBTC\": \"0.0000116363050651984\",\n  \"PHPUSD\": \"0.0201229266\",\n  \"PHPKRW\": \"22.4549558179\"\n}\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-PARTNER-ID","description":"Your organization's ID","options":{"required":true}},{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true},{"doc_url":"/developers/2/exchange_rates/show","name":"show","apis":[{"api_url":"/api/v2/exchange_rates/:currency_pair","http_method":"GET","short_description":"AUTHENTICATED: Returns a real-time hash of a specific currency pair. Updated every minute.","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eOur supported currencies include ADA, AED, AUD, AXS, BCH, BNB, BTC, BUSD, CAD, CNY, DASH, ETH, EUR, GBP, HKD, IDR, INR, JPY, KRW, LINK, LTC, MYR, NEAR, NPR, PAX, PHP, SGD, SLP, THB, USD, USDC, USDT, VND, XLM, XRP, ZAR. By default, all rates provided are relative to PHP.\u003c/p\u003e\n","errors":[],"params":[{"name":"currency_pair","full_name":"currency_pair","description":"\n\u003cp\u003e6-letter currency pair. ex: PHPUSD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["https://www.bloomremit.net/api/v2/exchange_rates/:currency_pair\n\n{\n  \"PHPUSD\": \"0.0201229266\",\n}\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-PARTNER-ID","description":"Your organization's ID","options":{"required":true}},{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null},"txns":{"doc_url":"/developers/2/txns","id":"txns","api_url":"/api","name":"Transactions","short_description":null,"full_description":"\n\u003cp\u003eTransactions 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.\u003c/p\u003e\n\n\u003cp\u003eUse the following endpoint to get updates on the transactions. See this POST call:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecurl -X POST 'https://www.bloomremit.net/message-bus/x/poll?dlp=t' -H 'Authorization: Basic MTox' -d %2Fv2%2Ftx_events=-50\u003c/code\u003e\u003c/pre\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003eMTox\u003c/code\u003e is your \u003ccode\u003epartner_id:partner_api_secret\u003c/code\u003e in base64 without newlines or spaces.\u003c/li\u003e\n\n\u003cli\u003e\u003ccode\u003e%2Fv2%2Ftx_events\u003c/code\u003e or \u003ccode\u003e/v2/tx_events\u003c/code\u003e is set to \u003ccode\u003e-50\u003c/code\u003e in the example, and this will return the last 49 events.\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cp\u003eYou may use \u003ca href=\"https://github.com/SamSaffron/message_bus\"\u003ehttps://github.com/SamSaffron/message_bus\u003c/a\u003e if you’re in Ruby, JS, or if you want to learn more.\u003c/p\u003e\n\n\u003cp\u003eHere’s a sample response:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e[\n  {\n    \"global_id\": 68510299,\n    \"message_id\": 10385646,\n    \"channel\": \"/v2/tx_events\",\n    \"data\": [\n      {\n        \"id\": \"5b72652d-f43f-4a2f-8dda-c60720d2f930\",\n        \"recipient_id\": \"30701c2f-a78a-4bee-bb66-5ea3cd3a401d\",\n        \"dest_currency\": \"PHP\",\n        \"receivable_in_dest_currency\": 1000,\n        \"payout_method\": \"CLH\",\n        \"status\": \"waiting\",\n        \"account_name\": \"Michael Jordan\",\n        \"account_number\": \"0292881777\",\n        \"tracking_sender\": \"Chase Patrol\",\n        \"tracking_number\": \"BLMKAMLUWAH\",\n        \"client_external_id\": \"cfa5fa57-c586-4f50-ae99-3568ba8830f6\",\n        \"purpose\": \"Help\",\n        \"sender_first_name\": \"Chase\",\n        \"sender_last_name\": \"Patrol\",\n        \"sender_email\": \"chase@pawpatrol.com\",\n        \"sender_address\": \"1 Lookout\",\n        \"sender_city\": \"Adventure Bay\",\n        \"sender_state\": \"Adventure State\",\n        \"sender_zip_code\": \"12323\",\n        \"sender_country\": \"Adventure Country\",\n        \"sender_occupation\": \"Rescue pup\",\n        \"recipient_first_name\": \"Michael\",\n        \"recipient_last_name\": \"Jordan\",\n        \"recipient_email\": \"michael@jordan.org\",\n        \"recipient_mobile\": \"09191234567\",\n        \"recipient_address\": \"21 Jump St\",\n        \"recipient_city\": \"Washington City\",\n        \"recipient_state\": \"WA\",\n        \"recipient_zip_code\": \"12345\",\n        \"recipient_country\": \"USA\",\n        \"recipient_occupation\": \"Baseball player\",\n        \"recipient_relationship_to_sender\": \"Idol\",\n        \"orig_currency\": \"BTC\",\n        \"paid_in_orig_currency\": 0.21\n      }\n    ]\n  }\n]\u003c/code\u003e\u003c/pre\u003e","version":"2","formats":null,"metadata":null,"methods":[{"doc_url":"/developers/2/txns/show","name":"show","apis":[{"api_url":"/api/v2/txns/:id","http_method":"GET","short_description":"Get transaction information","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["{\n  \"id\": \"18774f0d-0612-406e-a4ff-2c22586bced4\",\n  \"recipient_id\": \"cb7d2f43-6b71-4e09-bbe1-5db24ccc98a9\",\n  \"dest_currency\": \"PHP\",\n  \"receivable_in_dest_currency\": 1000,\n  \"payout_method\": \"CLH\",\n  \"status\": \"waiting\",\n  \"account_name\": \"Michael Jordan\",\n  \"account_number\": \"0292881777\",\n  \"tracking_sender\": \"Chase Patrol\",\n  \"tracking_number\": \"BLMKAMLUWAH\",\n  \"client_external_id\": \"8965b5e6-a100-421c-b886-76ead6137eec\",\n  \"purpose\": \"Help\",\n  \"sender_first_name\": \"Chase\",\n  \"sender_last_name\": \"Patrol\",\n  \"sender_email\": \"chase@pawpatrol.com\",\n  \"sender_address\": \"1 Lookout\",\n  \"sender_city\": \"Adventure Bay\",\n  \"sender_state\": \"Adventure State\",\n  \"sender_zip_code\": \"12323\",\n  \"sender_country\": \"Adventure Country\",\n  \"sender_occupation\": \"Rescue pup\",\n  \"recipient_first_name\": \"Michael\",\n  \"recipient_last_name\": \"Jordan\",\n  \"recipient_email\": \"michael@jordan.org\",\n  \"recipient_mobile\": \"09191234567\",\n  \"recipient_address\": \"21 Jump St\",\n  \"recipient_city\": \"Washington City\",\n  \"recipient_state\": \"WA\",\n  \"recipient_zip_code\": \"12345\",\n  \"recipient_country\": \"USA\",\n  \"recipient_occupation\": \"Baseball player\",\n  \"recipient_relationship_to_sender\": \"Idol\",\n  \"orig_currency\": \"BTC\",\n  \"paid_in_orig_currency\": 0.21\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/developers/2/txns/create","name":"create","apis":[{"api_url":"/api/v2/txns","http_method":"POST","short_description":"Create transactions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"txn","full_name":"txn","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"sender_first_name","full_name":"txn[sender_first_name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sender_last_name","full_name":"txn[sender_last_name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sender_email","full_name":"txn[sender_email]","description":"\n\u003cp\u003eRequired if no mobile is provided\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sender_mobile","full_name":"txn[sender_mobile]","description":"\n\u003cp\u003eRequired if no email is provided. Include country code, i.e. +639172119087\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sender_address","full_name":"txn[sender_address]","description":"\n\u003cp\u003eStreet address of sender. Required if depositing to a bank account.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sender_city","full_name":"txn[sender_city]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sender_state","full_name":"txn[sender_state]","description":"\n\u003cp\u003eState/province of the sender\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sender_zip_code","full_name":"txn[sender_zip_code]","description":"\n\u003cp\u003eRequired if depositing to a bank account\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sender_country","full_name":"txn[sender_country]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sender_occupation","full_name":"txn[sender_occupation]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recipient_first_name","full_name":"txn[recipient_first_name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recipient_last_name","full_name":"txn[recipient_last_name]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recipient_email","full_name":"txn[recipient_email]","description":"\n\u003cp\u003eRequired if recipient mobile is blank\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recipient_mobile","full_name":"txn[recipient_mobile]","description":"\n\u003cp\u003eInclude country code, i.e. +639172119087; required if recipient email is blank\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recipient_address","full_name":"txn[recipient_address]","description":"\n\u003cp\u003eStreet address of recipient. Required if depositing to a bank account.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recipient_city","full_name":"txn[recipient_city]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recipient_state","full_name":"txn[recipient_state]","description":"\n\u003cp\u003eState/province of the recipient\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recipient_zip_code","full_name":"txn[recipient_zip_code]","description":"\n\u003cp\u003eRequired if depositing to a bank account\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recipient_country","full_name":"txn[recipient_country]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recipient_occupation","full_name":"txn[recipient_occupation]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"recipient_relationship_to_sender","full_name":"txn[recipient_relationship_to_sender]","description":"\n\u003cp\u003e‘Father’ if recipient is the father of the sender\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dest_currency","full_name":"txn[dest_currency]","description":"\n\u003cp\u003eISO 4217 currency code that Bloom and the payout method supports, i.e. PHP\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"receivable_in_dest_currency","full_name":"txn[receivable_in_dest_currency]","description":"\n\u003cp\u003eAmount the recipient is to receive\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"payout_method","full_name":"txn[payout_method]","description":"\n\u003cp\u003eBank/remittance center where this will be sent. See /developers/1/static\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"purpose","full_name":"txn[purpose]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_number","full_name":"txn[account_number]","description":"\n\u003cp\u003eOnly for bank deposits\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account_name","full_name":"txn[account_name]","description":"\n\u003cp\u003eOnly for bank deposits\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"client_external_id","full_name":"txn[client_external_id]","description":"\n\u003cp\u003eUnique ID that you use to refer to this transaction\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"orig_currency","full_name":"txn[orig_currency]","description":"\n\u003cp\u003eOrigin currency (tracking purposes only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paid_in_orig_currency","full_name":"txn[paid_in_orig_currency]","description":"\n\u003cp\u003eOrigin currency amount (tracking purposes only)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["Sample response:\n{\n  \"txn\": {\n    \"id\": \"d35ccb47-fe81-417d-b526-355ee71d2ad0\",\n    \"recipient_id\": \"a847e633-c3d0-4cce-ba77-c9c9b8535446\",\n    \"dest_currency\": \"PHP\",\n    \"receivable_in_dest_currency\": 1000,\n    \"payout_method\": \"CLH\",\n    \"status\": \"waiting\",\n    \"account_name\": \"Michael Jordan\",\n    \"account_number\": \"0292881777\",\n    \"tracking_sender\": \"Chase Patrol\",\n    \"tracking_number\": \"BLMKAMLUWAH\",\n    \"client_external_id\": \"f6d4c686-0ccd-4397-bf16-108567ccb5de\",\n    \"purpose\": \"Help\",\n    \"sender_first_name\": \"Chase\",\n    \"sender_last_name\": \"Patrol\",\n    \"sender_email\": \"chase@pawpatrol.com\",\n    \"sender_address\": \"1 Lookout\",\n    \"sender_city\": \"Adventure Bay\",\n    \"sender_state\": \"Adventure State\",\n    \"sender_zip_code\": \"12323\",\n    \"sender_country\": \"Adventure Country\",\n    \"sender_occupation\": \"Rescue pup\",\n    \"recipient_first_name\": \"Michael\",\n    \"recipient_last_name\": \"Jordan\",\n    \"recipient_email\": \"michael@jordan.org\",\n    \"recipient_mobile\": \"09191234567\",\n    \"recipient_address\": \"21 Jump St\",\n    \"recipient_city\": \"Washington City\",\n    \"recipient_state\": \"WA\",\n    \"recipient_zip_code\": \"12345\",\n    \"recipient_country\": \"USA\",\n    \"recipient_occupation\": \"Baseball player\",\n    \"recipient_relationship_to_sender\": \"Idol\",\n    \"orig_currency\": \"BTC\",\n    \"paid_in_orig_currency\": 0.21\n  }\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[{"name":"X-API-PARTNER-ID","description":"Your organization's ID","options":{"required":true}},{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"deprecated":false}}}}