{"docs":{"name":"Bloom","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"/developers/2","api_url":"/api","resources":[{"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\": \"d3dd5761-80be-4c04-841b-47102d67ae41\",\n        \"recipient_id\": \"b363a191-4c71-4c2e-b7ae-4ca9ee9fbc6a\",\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\": \"c029acca-82f6-4de8-9b72-5ee0a2e37211\",\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\": \"0310c114-d9ca-4091-bff8-b49766d1f2d7\",\n  \"recipient_id\": \"865f2e72-2d0b-4544-ba64-a1c7bff53c1a\",\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\": \"1ed4d216-0de4-421e-aae0-9ee9a6b61aa2\",\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\": \"19c0ef64-e5c3-4ecd-8174-76a336ceee4e\",\n    \"recipient_id\": \"f758e75f-291e-4f3b-b400-0e1bfd6c9de9\",\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\": \"152b544c-3553-43f0-8b98-9c3c826eeb10\",\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}]}}