{"docs":{"name":"Bloom","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"/developers/1","api_url":"/api","resources":[{"doc_url":"/developers/1/remittances","id":"remittances","api_url":"/api","name":"Remittances","short_description":null,"full_description":null,"version":"1","formats":null,"metadata":null,"methods":[{"doc_url":"/developers/1/remittances/index","name":"index","apis":[{"api_url":"/api/v1/partners/:api_token/senders/:sender_id/remittances","http_method":"GET","short_description":"Show all remittances belonging to the given user","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturns a hash with a single key \u003ccode\u003eremittance_ids\u003c/code\u003e, containing an array of integers corresponding to the IDs of the remittance records belonging to the specified user.\u003c/p\u003e\n\n\u003cp\u003eSample URL:\u003c/p\u003e\n\n\u003cpre\u003e\u003ccode\u003ehttps://www.bloomremit.net/api/v1/partners/:api_token/senders/9831bc1f-e531-47d0-bc00-db32dbe875d7/remittances\u003c/code\u003e\u003c/pre\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true},{"doc_url":"/developers/1/remittances/create","name":"create","apis":[{"api_url":"/api/v1/partners/:api_token/senders/:sender_id/remittances","http_method":"POST","short_description":"Initiate a new money transfer by providing a recipient_id and a remittance hash. (VENDOR partner version)","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":404,"description":"Couldn't find a recipient record with that ID","metadata":null},{"code":422,"description":"Request was correctly parsed but there is missing information","metadata":null}],"params":[{"name":"recipient_id","full_name":"recipient_id","description":"\n\u003cp\u003eRecipient ID\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":"remittance","full_name":"remittance","description":"\n\u003cp\u003eRemittance instructions\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"orig_currency","full_name":"remittance[orig_currency]","description":"\n\u003cp\u003eCurrency of Origin (Ex. ‘USD’, ‘KRW’)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eADA\u003c/code\u003e, \u003ccode\u003eAED\u003c/code\u003e, \u003ccode\u003eAUD\u003c/code\u003e, \u003ccode\u003eAXS\u003c/code\u003e, \u003ccode\u003eBCH\u003c/code\u003e, \u003ccode\u003eBNB\u003c/code\u003e, \u003ccode\u003eBUSD\u003c/code\u003e, \u003ccode\u003eCAD\u003c/code\u003e, \u003ccode\u003eCNY\u003c/code\u003e, \u003ccode\u003eDASH\u003c/code\u003e, \u003ccode\u003eEUR\u003c/code\u003e, \u003ccode\u003eGBP\u003c/code\u003e, \u003ccode\u003eHKD\u003c/code\u003e, \u003ccode\u003eIDR\u003c/code\u003e, \u003ccode\u003eINR\u003c/code\u003e, \u003ccode\u003eJPY\u003c/code\u003e, \u003ccode\u003eKRW\u003c/code\u003e, \u003ccode\u003eLINK\u003c/code\u003e, \u003ccode\u003eMYR\u003c/code\u003e, \u003ccode\u003eNEAR\u003c/code\u003e, \u003ccode\u003eNPR\u003c/code\u003e, \u003ccode\u003ePAX\u003c/code\u003e, \u003ccode\u003ePHP\u003c/code\u003e, \u003ccode\u003eSGD\u003c/code\u003e, \u003ccode\u003eSLP\u003c/code\u003e, \u003ccode\u003eTHB\u003c/code\u003e, \u003ccode\u003eUSD\u003c/code\u003e, \u003ccode\u003eUSDC\u003c/code\u003e, \u003ccode\u003eUSDT\u003c/code\u003e, \u003ccode\u003eVND\u003c/code\u003e, \u003ccode\u003eZAR\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"paid_in_orig_currency","full_name":"remittance[paid_in_orig_currency]","description":"\n\u003cp\u003eAmount paid by customer (Ex. 20000.0). Must be filled if ‘receivable_in_dest_currency’ is not set. If both are set, then this amount is disregarded.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"flat_fee_in_orig_currency","full_name":"remittance[flat_fee_in_orig_currency]","description":"\n\u003cp\u003eFlat service fee that you wish to add to the total bill of your sender. Leave this blank to use your default fee (if any).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"forex_margin","full_name":"remittance[forex_margin]","description":"\n\u003cp\u003eAdditional foreign-exchange percentage to add to the total bill of your sender. Leave this blank to use your default margin (if any).\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"dest_currency","full_name":"remittance[dest_currency]","description":"\n\u003cp\u003eCurrency of Destination\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eADA\u003c/code\u003e, \u003ccode\u003eAED\u003c/code\u003e, \u003ccode\u003eAUD\u003c/code\u003e, \u003ccode\u003eAXS\u003c/code\u003e, \u003ccode\u003eBCH\u003c/code\u003e, \u003ccode\u003eBNB\u003c/code\u003e, \u003ccode\u003eBUSD\u003c/code\u003e, \u003ccode\u003eCAD\u003c/code\u003e, \u003ccode\u003eCNY\u003c/code\u003e, \u003ccode\u003eDASH\u003c/code\u003e, \u003ccode\u003eEUR\u003c/code\u003e, \u003ccode\u003eGBP\u003c/code\u003e, \u003ccode\u003eHKD\u003c/code\u003e, \u003ccode\u003eIDR\u003c/code\u003e, \u003ccode\u003eINR\u003c/code\u003e, \u003ccode\u003eJPY\u003c/code\u003e, \u003ccode\u003eKRW\u003c/code\u003e, \u003ccode\u003eLINK\u003c/code\u003e, \u003ccode\u003eMYR\u003c/code\u003e, \u003ccode\u003eNEAR\u003c/code\u003e, \u003ccode\u003eNPR\u003c/code\u003e, \u003ccode\u003ePAX\u003c/code\u003e, \u003ccode\u003ePHP\u003c/code\u003e, \u003ccode\u003eSGD\u003c/code\u003e, \u003ccode\u003eSLP\u003c/code\u003e, \u003ccode\u003eTHB\u003c/code\u003e, \u003ccode\u003eUSD\u003c/code\u003e, \u003ccode\u003eUSDC\u003c/code\u003e, \u003ccode\u003eUSDT\u003c/code\u003e, \u003ccode\u003eVND\u003c/code\u003e, \u003ccode\u003eZAR\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"receivable_in_dest_currency","full_name":"remittance[receivable_in_dest_currency]","description":"\n\u003cp\u003eAmount received by recipient (Ex. 1000.00). Must be filled if ‘paid_in_orig_currency’ is not set. If both are set, then this amount is used to calculate and override ‘paid_in_orig_currency’.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"payout_method","full_name":"remittance[payout_method]","description":"\n\u003cp\u003eWhere this remittance will be deposited. Must be listed in https://www.bloomremit.net/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":"account_name","full_name":"remittance[account_name]","description":"\n\u003cp\u003eFull Name of Bank Account Holder\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_number","full_name":"remittance[account_number]","description":"\n\u003cp\u003eBank Account Number\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":"remittance[client_external_id]","description":"\n\u003cp\u003eUnique code you want to refer to this transaction; this can only be submitted once. If not given, one will be generated for you, but it is strongly recommended that you generate it yourself to avoid accidentally processing multiple transactions.\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_first_name","full_name":"remittance[recipient_first_name]","description":"\n\u003cp\u003eRecommended way to set recipient information. This will take precedence over the given recipient_id\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_last_name","full_name":"remittance[recipient_last_name]","description":"\n\u003cp\u003eRecommended way to set recipient information. This will take precendence over what is found in recipient_id\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_email","full_name":"remittance[recipient_email]","description":"\n\u003cp\u003eRecommended way to set recipient information. This will take precendence over what is found in recipient_id\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":"remittance[recipient_mobile]","description":"\n\u003cp\u003eRecommended way to set recipient information. This will take precendence over what is found in recipient_id\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":"remittance[recipient_address]","description":"\n\u003cp\u003eRecommended way to set recipient information. This will take precendence over what is found in recipient_id\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":"remittance[recipient_city]","description":"\n\u003cp\u003eRecommended way to set recipient information. This will take precendence over what is found in recipient_id\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_state","full_name":"remittance[recipient_state]","description":"\n\u003cp\u003eRecommended way to set recipient information. This will take precendence over what is found in recipient_id\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_zip_code","full_name":"remittance[recipient_zip_code]","description":"\n\u003cp\u003eRecommended way to set recipient information. This will take precendence over what is found in recipient_id\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":"remittance[recipient_country]","description":"\n\u003cp\u003eRecommended way to set recipient information. This will take precendence over what is found in recipient_id\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_occupation","full_name":"remittance[recipient_occupation]","description":"\n\u003cp\u003eRecommended way to set recipient information. This will take precendence over what is found in recipient_id\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_relationship_to_sender","full_name":"remittance[recipient_relationship_to_sender]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sender_first_name","full_name":"remittance[sender_first_name]","description":"\n\u003cp\u003eRecommended way to set sender information. This will take precendence over what is found in sender_id\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_last_name","full_name":"remittance[sender_last_name]","description":"\n\u003cp\u003eRecommended way to set sender information. This will take precendence over what is found in sender_id\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_email","full_name":"remittance[sender_email]","description":"\n\u003cp\u003eRecommended way to set sender information. This will take precendence over what is found in sender_id\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":"remittance[sender_mobile]","description":"\n\u003cp\u003eRecommended way to set sender information. This will take precendence over what is found in sender_id\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":"remittance[sender_address]","description":"\n\u003cp\u003eRecommended way to set sender information. This will take precendence over what is found in sender_id\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":"remittance[sender_city]","description":"\n\u003cp\u003eRecommended way to set sender information. This will take precendence over what is found in sender_id\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_state","full_name":"remittance[sender_state]","description":"\n\u003cp\u003eRecommended way to set sender information. This will take precendence over what is found in sender_id\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_zip_code","full_name":"remittance[sender_zip_code]","description":"\n\u003cp\u003eRecommended way to set sender information. This will take precendence over what is found in sender_id\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":"remittance[sender_country]","description":"\n\u003cp\u003eRecommended way to set sender information. This will take precendence over what is found in sender_id\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_occupation","full_name":"remittance[sender_occupation]","description":"\n\u003cp\u003eRecommended way to set sender information. This will take precendence over what is found in sender_id\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":"purpose","full_name":"remittance[purpose]","description":"\n\u003cp\u003eReason for remittance\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":"callback_url","full_name":"remittance[callback_url]","description":"\n\u003cp\u003e[DEPRECATED] Subscribe to \u003ccode\u003e/tx_events\u003c/code\u003e instead\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":["# Example URL\n\nhttp://www.bloomremit.net/api/v1/partners/:api_token/senders/1/remittances\n","# Example bank remittance\n\n{\n  \"recipient_id\" : 1,\n  \"remittance\" : {\n    \"account_name\": \"Luis Buenaventura\",\n    \"account_number\": \"1234567890\",\n    \"dest_currency\": \"PHP\",\n    \"flat_fee_in_orig_currency\": 3000,\n    \"forex_margin\": 0.5,\n    \"orig_currency\": \"KRW\",\n    \"paid_in_orig_currency\": 15000,\n    \"payout_method\": \"BPI\",\n    \"receivable_in_dest_currency\": 500\n  }\n}\n\n# Some destinations require more information, like Vietnamese banks:\n{\n  \"recipient_id\" : 1,\n  \"remittance\" : {\n    # same as above, plus:\n    \"account_branch_address\": \"23 Nguyen, HCM\",\n    \"account_branch_name\": \"Bank of HCM, Nguyen-HCM\"\n  }\n}\n","# Example cash pickup remittance\n\n{\n  \"recipient_id\": 1,\n  \"remittance\": {\n    \"receivable_in_dest_currency\": 10000.0,\n    \"dest_currency\": \"PHP\",\n    \"payout_method\": \"CLH\"\n  }\n}\n","# Instead of using callback_url, you are encouraged to use get updates on\n# the transactions by make the following POST call:\n\ncurl -X GET 'https://www.bloomremit.net/message-bus/x/poll?dlp=t' -H 'Authorization: Basic MTox' -d %2Ftx_events=-50\n\n# `MTox` is your partner_id:partner_api_secret in base64 without newlines\n# or spaces\n#\n# `%2Ftx_events` or `/tx_events` is set to -50 in the example, and this will\n# return the last 49 events.\n\n# You may use https://github.com/SamSaffron/message_bus if you're in Ruby,\n# JS, or if you want to learn more.\n\n# Here's an example reply:\n\n[\n  {\n    \"global_id\": 68510299,\n    \"message_id\": 10385646,\n    \"channel\": \"/exchange_rates\",\n    \"data\": {\n      \"id\": 100,\n      \"partner_id\": 1,\n      \"recipient_id\": 1,\n      \"orig_currency\": \"KRW\",\n      \"dest_currency\": \"PHP\",\n      \"paid_in_orig_currency\": 30000,\n      \"receivable_in_dest_currency\": 500,\n      \"forex_margin\": 1.0,\n      \"flat_fee_in_orig_currency\": 2000,\n      \"payout_method\": \"BDO\",\n      \"status\": \"error\",\n      \"status_description\": \"Transaction error\",\n      \"teller_id\": 2\n    }\n  }\n]\n","# Example 200 (successful) response for bank deposit\n{\n  \"remittance\": {\n    \"id\": \"fa672cc7-6006-46e6-9e64-14ac412cb2a4\",\n    \"teller_id\": \"c2002ad1-7618-4592-b868-409ab209fdcf\",\n    \"recipient_id\": \"4ae1f668-3b00-40ff-81b6-284660083b45\",\n    \"orig_currency\": \"KRW\",\n    \"dest_currency\": \"PHP\",\n    \"paid_in_orig_currency\": 15000.0,\n    \"receivable_in_dest_currency\": 500.0,\n    \"status\": \"waiting\",\n    \"payout_method\": \"CBC\",\n    \"partner_id\": \"049902b7-f09e-4675-a835-76df30017b94\",\n    \"flat_fee_in_orig_currency\": 3000.0,\n    \"forex_margin\": 0.0,\n    \"account_name\": \"Luis Buenaventura\",\n    \"account_number\": \"1234567890\",\n    \"purpose\": \"Salary\",\n    \"callback_url\": \"http://yourwebsite.com/remittances/1/callback_for_bloom\",\n    \"sender_id\": \"d96f181e-d106-410d-86e0-2c91306dc97f\"\n  }\n}\n","# Example 200 (successful) response for cash pickup\n{\n  \"remittance\": {\n    \"id\": \"fa672cc7-6006-46e6-9e64-14ac412cb2a4\",\n    \"teller_id\": \"c2002ad1-7618-4592-b868-409ab209fdcf\",\n    \"recipient_id\": \"4ae1f668-3b00-40ff-81b6-284660083b45\",\n    \"orig_currency\": \"KRW\",\n    \"dest_currency\": \"PHP\",\n    \"paid_in_orig_currency\": 15000.0,\n    \"receivable_in_dest_currency\": 500.0,\n    \"status\": \"waiting\",\n    \"payout_method\": \"CBC\",\n    \"partner_id\": \"049902b7-f09e-4675-a835-76df30017b94\",\n    \"flat_fee_in_orig_currency\": 3000.0,\n    \"forex_margin\": 0.0,\n    \"tracking_sender\": \"Luis Buenaventura\",\n    # if tracking_number is known, we show it. If not known yet this will be blank. You may poll the update channel (message bus) for the tracking_number.\n    \"tracking_number\": \"BLMHUMAWAYA\",\n    \"callback_url\": \"http://yourwebsite.com/remittances/1/callback_for_bloom\",\n    \"sender_id\": \"d96f181e-d106-410d-86e0-2c91306dc97f\"\n  }\n}\n","# Example 422 (error) response when the bank account number is wrong\n\n{\n  \"errors\": [\n    \"Account number is invalid. The number must be 10-12 digits long with no spaces.\"\n  ]\n}\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true},{"doc_url":"/developers/1/remittances/show","name":"show","apis":[{"api_url":"/api/v1/partners/:api_token/senders/:sender_id/remittances/:id","http_method":"GET","short_description":"Show information about a given recipient along with their associated remittance. (VENDOR partner version)","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eAll information about the given remittance and recipient are returned with this call. Important fields to note include \u003ccode\u003estatus\u003c/code\u003e and \u003ccode\u003ereceivable_in_dest_currency\u003c/code\u003e.\u003c/p\u003e\n\n\u003cp\u003eStatuses can be one of the following:\u003c/p\u003e\n\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003ewaiting\u003c/code\u003e: We’re waiting for confirmation from the payout partner\u003c/li\u003e\n\n\u003cli\u003e\u003ccode\u003eerror\u003c/code\u003e: General failure, please contact support\u003c/li\u003e\n\n\u003cli\u003e\u003ccode\u003ecancelling\u003c/code\u003e: This transaction is being cancelled\u003c/li\u003e\n\n\u003cli\u003e\u003ccode\u003eoutstanding\u003c/code\u003e: Transaction is waiting to be claimed by the recipient (only used in cash-pickup transactions)\u003c/li\u003e\n\n\u003cli\u003e\u003ccode\u003ecancelled\u003c/code\u003e: This transaction has been cancelled\u003c/li\u003e\n\n\u003cli\u003e\u003ccode\u003ecompleted\u003c/code\u003e: This transaction is complete\u003c/li\u003e\n\u003c/ul\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRemittance ID\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":["{\n  \"recipient\": {\n    \"id\": \"client-ref-id\",\n    \"first_name\": \"Johnny\",\n    \"last_name\": \"Bravo\",\n    \"email\": \"johnny@bravo.ph\",\n    \"mobile\": \"0639175551112\",\n    \"city\": \"Makati City\",\n    \"state\": \"Metro Manila\",\n    \"created_at\": \"2025-07-04 14:44:33 +0800\",\n    \"updated_at\": \"2025-07-04 16:42:33 +0800\"\n  },\n  \"remittance\": {\n    \"id\": \"ba74df2f-8e2c-4f45-9d10-c5c2708eab8f\",\n    \"partner_id\": \"d2b0866d-3e3a-4191-aa74-1465bd53ef6a\",\n    \"recipient_id\": \"client-ref-id\",\n    \"receivable_in_dest_currency\": 35000,\n    \"payout_method\": \"CLH\",\n    \"status\": \"waiting\",\n    \"tracking_number\": \"BLMKAMLUWAH\",\n    \"sender_id\": \"c6fcde65-be6f-4c50-8a73-10d2a6ca27f5\",\n    \"client_external_id\": \"client-external-id\"\n  }\n}"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true},{"doc_url":"/developers/1/remittances/destroy","name":"destroy","apis":[{"api_url":"/api/v1/partners/:api_token/senders/:sender_id/remittances/:id","http_method":"DELETE","short_description":"Cancel a remittance. Note that this changes the status of the remittance to 'cancelled' and refunds the partner credits used, but does not delete it from the database. ","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCancel a remittance. We never delete records so you will still be able to retrieve any cancelled remittances. Internally, we set the status to \u003ccode\u003ecancelling\u003c/code\u003e and then \u003ccode\u003ecancelled\u003c/code\u003e once we have confirmed that it is safe to cancel. You can cancel remittances that are in the statuses \u003ccode\u003ewaiting\u003c/code\u003e, \u003ccode\u003epaid\u003c/code\u003e, \u003ccode\u003edelayed\u003c/code\u003e, \u003ccode\u003eerror\u003c/code\u003e, and \u003ccode\u003eoutstanding\u003c/code\u003e.\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eRemittance ID (UUID)\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":[],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true},{"doc_url":"/developers/1/remittances/calculate","name":"calculate","apis":[{"api_url":"/api/v1/partners/:api_token/remittances/calculate","http_method":"POST","short_description":"Returns the total fees for a given remittance amount and payout method.","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eIn order to calculate the cost of a given remittance, you will need to provide an amount, a currency, and a payout_method. You may provide either the origin_amount (the money paid by the sender), or the \u003ccode\u003edestination_amount\u003c/code\u003e (the money received by the beneficiary), and the calculator will compute the fees automatically.\u003c/p\u003e\n\n\u003cp\u003eIf you provide the \u003ccode\u003eorigin_amount\u003c/code\u003e, the calculator will give you the amount receivable at the destination of the remittance. If you provide the \u003ccode\u003edestination_amount\u003c/code\u003e, the calculator will give you the amount that must be paid by the sender at the point of origin.\u003c/p\u003e\n","errors":[],"params":[{"name":"origin_amount","full_name":"origin_amount","description":"\n\u003cp\u003eAmount payable at origin\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":"origin_currency","full_name":"origin_currency","description":"\n\u003cp\u003eCurrency of origin (If blank, will use partner’s default origin currency)\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":"destination_amount","full_name":"destination_amount","description":"\n\u003cp\u003eAmount receivable at destination\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":"destination_currency","full_name":"destination_currency","description":"\n\u003cp\u003eCurrency of destination (If blank, will use partner’s default destination currency)\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":"payout_method","full_name":"payout_method","description":"\n\u003cp\u003eWhere this remittance will be deposited. Must be listed in https://www.bloomremit.net/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":[]}],"returns":[],"examples":["{\n  origin_amount: 15000,\n  origin_currency: 'KRW',\n  payout_method: \"CLH\"\n}\n","{\n  destination_amount: 10000,\n  destination_currency: 'PHP',\n  payout_method: \"CLH\"\n}\n","{\n  origin_amount: 125000,\n  payout_method: \"CLH\"\n}\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{"required":true}}],"show":true}],"headers":null,"deprecated":null}]}}