{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/transfers","auth":"required","examples":{"codes":[{"code":"{\n  \"dest\": {\n    \"paymentMethodType\":\"INTERNATIONAL_TRANSFER\",\n    \"bankCode\":\"341\",\n    \"bankName\":\"ITAU\",\n    \"branchCode\":\"6199\",\n    \"nameOnAccount\":\"Steve McQueen\",\n    \"accountNumber\":\"4444-5\",\n    \"accountType\":\"corrente\",\n    \"cpfCnpj\":\"00000000000\",\n    \"currency\":\"BRL\",\n    \"country\":\"BR\",\n    \"accountHolderPhoneNumber\":\"+559936210617\"\n  },\n  \"sourceCurrency\": \"BRL\",\n  \"destCurrency\": \"BRL\",\n  \"destAmount\": 10,\n  \"message\":\"Transfer message\"\n}","language":"json"}]},"method":"post","params":[{"name":"dest","type":"object","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf3086"},{"name":"dest.paymentMethodType:","type":"string","default":"","desc":"Must be `INTERNATIONAL_TRANSFER` - a signal to our system on how to process the dest object","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf3085"},{"name":"dest.bankCode","type":"string","default":"","desc":"Beneficiary bank code; [Supported BR Bank Codes](https://api.sendwyre.com/v2/bankinfo/BR)","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf3084"},{"name":"dest.bankName","type":"string","default":"","desc":"Beneficiary bank name","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf3083"},{"name":"dest.branchCode","type":"string","default":"","desc":"Beneficiary branch code (see formatting rules below)","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf3082"},{"name":"dest.nameOnAccount","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf3081"},{"name":"dest.accountNumber","type":"string","default":"","desc":"All account numbers require the check digit. The check digit is the number after the `-` in the account number.","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf3080"},{"name":"dest.accountType","type":"string","default":"","desc":"`corrente`","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf307f"},{"name":"dest.cpfCnpj","type":"string","default":"","desc":"Brazilian tax identification numbers","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf307e"},{"name":"dest.currency","type":"string","default":"","desc":"Currency to deposit - must match root object property destCurrency","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf307d"},{"name":"dest.country","type":"string","default":"","desc":"Country of beneficiary bank","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf307c"},{"name":"dest.accountHolderPhoneNumber","type":"string","default":"","desc":"Beneficiary phone number","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf307b"},{"name":"sourceCurrency","type":"string","default":"","desc":"string Currency to be debited from your account","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf307a"},{"name":"destCurrency","type":"string","default":"","desc":"Currency to be deposited to the dest. If destCurrency doesn't match the sourceCurrency an exchange will be performed","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf3079"},{"name":"destAmount","type":"float","default":"","desc":"Amount to be deposited to the dest - the amount debited from your account will be calculated automatically from the exchange rate/fees.","required":true,"in":"body","ref":"","_id":"5a1c7239f26eca001edf3078"},{"name":"message","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a1c7239f26eca001edf3077"},{"name":"autoConfirm","type":"string","default":"","desc":"An optional parameter to automatically confirm the transfer order.","required":false,"in":"body","ref":"","_id":"5a26e9a3ebdd09002892979c"},{"name":"callbackUrl","type":"string","default":"","desc":"An optional url that Wyre will POST a status callback to (see [Callbacks](doc:callbacks))","required":false,"in":"body","ref":"","_id":"5a26e9a3ebdd09002892979b"}],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Payouts to πŸ‡§πŸ‡· BRAZIL","type":"endpoint","slug":"usd-balance-brl-bank-account","excerpt":"","body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**Payout Options**\",\n    \"0-1\": \"Banking rails only\",\n    \"1-0\": \"**Banking Coverage**\",\n    \"2-0\": \"**Delivery Times**\",\n    \"3-0\": \"**Limits**\",\n    \"1-1\": \"- Caixa Economica Federal\\t\\n- Bradesco\\t\\n- Banco do Brasil\\t\\n- *All other banks*\",\n    \"2-1\": \"Caixa Economica Federal, Bradesco, & Banco do Brasil:\\n - 1 business day to affiliate the account\\t\\n - 30 minutes to 24 hours to complete the transactions\\n\\nAll other banks*:\\n - 1 business day to affiliate the account\\t\\n - 30 minutes to 24 hours to complete the transaction if sent before 3pm and above R$ 250, (otherwise next day)\",\n    \"3-1\": \"For Brazilian banks, we have minimum deposits that users can make. The specific amount depends on the institution:\\n- Banco do Brasil - 10 BRL\\n- Bradesco - 10 BRL\\n- Caixa - 10 BRL\\n- Other banks - 50 BRL\\n\\nPlease note that if you attempt to deposit an amount less than the above minimums, your payment will *not* be processed.\",\n    \"4-0\": \"**Branch Codes**\",\n    \"4-1\": \"You may format the branch code 1 of 2 ways:\\n\\nFor Banco do Brasil (bank code 001) and Caixa (bank code 104): \\\"####-#\\\" - where the first 4 digits are the branch number and the final digit is the branch check digit. Example: \\\"3325-1\\\"\\n\\nFor all other banks: \\\"####\\\" - a 4 digit branch number. Example \\\"3325\\\"\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c72e13f795cf0d003ec16a","category":{"sync":{"isSync":false,"url":""},"pages":["56c72e13f795cf0d003ec16a","56c72e537bb0fc0d00a973f0","56c72e77dd0b310d00e82ef1","56c72ee4862f940d00564762","56ccfdb48fa8b01b00b8202c"],"title":"Payout Currencies","slug":"transfer-examples","order":6,"from_sync":false,"reference":false,"_id":"56c72df5b3625c0d00422c9e","__v":5,"version":"55909cb433090f0d004d25d8","createdAt":"2016-02-19T15:00:05.865Z","project":"558b53f749dc4f0d00517de0"},"githubsync":"","createdAt":"2016-02-19T15:00:35.138Z","project":"558b53f749dc4f0d00517de0","user":"54eb883f4f94620d00789aaa","__v":34,"parentDoc":null,"version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["55909cb433090f0d004d25d9","55909cb433090f0d004d25da","55909cb433090f0d004d25db","55909cb433090f0d004d25dc","56c72c00197f9f1700c811db","56c72df5b3625c0d00422c9e","56e1b646150ed52d0062c652","56e9fe9779708c0e002b6026","57312dc94245100e001743f4","57646a570742400e00c04701","5894c96f4d9c7e27002e42ba"],"_id":"55909cb433090f0d004d25d8","project":"558b53f749dc4f0d00517de0","releaseDate":"2015-06-29T01:17:40.214Z","createdAt":"2015-06-29T01:17:40.214Z","forked_from":"558b53f749dc4f0d00517de3","__v":8}}

postPayouts to πŸ‡§πŸ‡· BRAZIL


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

dest:
required
object
dest.paymentMethodType:
required
string
Must be `INTERNATIONAL_TRANSFER` - a signal to our system on how to process the dest object
dest.bankCode:
required
string
Beneficiary bank code; [Supported BR Bank Codes](https://api.sendwyre.com/v2/bankinfo/BR)
dest.bankName:
required
string
Beneficiary bank name
dest.branchCode:
required
string
Beneficiary branch code (see formatting rules below)
dest.nameOnAccount:
required
string
dest.accountNumber:
required
string
All account numbers require the check digit. The check digit is the number after the `-` in the account number.
dest.accountType:
required
string
`corrente`
dest.cpfCnpj:
required
string
Brazilian tax identification numbers
dest.currency:
required
string
Currency to deposit - must match root object property destCurrency
dest.country:
required
string
Country of beneficiary bank
dest.accountHolderPhoneNumber:
required
string
Beneficiary phone number
sourceCurrency:
required
string
string Currency to be debited from your account
destCurrency:
required
string
Currency to be deposited to the dest. If destCurrency doesn't match the sourceCurrency an exchange will be performed
destAmount:
required
float
Amount to be deposited to the dest - the amount debited from your account will be calculated automatically from the exchange rate/fees.
message:
string
autoConfirm:
string
An optional parameter to automatically confirm the transfer order.
callbackUrl:
string
An optional url that Wyre will POST a status callback to (see [Callbacks](doc:callbacks))

Examples


Documentation

[block:parameters] { "data": { "0-0": "**Payout Options**", "0-1": "Banking rails only", "1-0": "**Banking Coverage**", "2-0": "**Delivery Times**", "3-0": "**Limits**", "1-1": "- Caixa Economica Federal\t\n- Bradesco\t\n- Banco do Brasil\t\n- *All other banks*", "2-1": "Caixa Economica Federal, Bradesco, & Banco do Brasil:\n - 1 business day to affiliate the account\t\n - 30 minutes to 24 hours to complete the transactions\n\nAll other banks*:\n - 1 business day to affiliate the account\t\n - 30 minutes to 24 hours to complete the transaction if sent before 3pm and above R$ 250, (otherwise next day)", "3-1": "For Brazilian banks, we have minimum deposits that users can make. The specific amount depends on the institution:\n- Banco do Brasil - 10 BRL\n- Bradesco - 10 BRL\n- Caixa - 10 BRL\n- Other banks - 50 BRL\n\nPlease note that if you attempt to deposit an amount less than the above minimums, your payment will *not* be processed.", "4-0": "**Branch Codes**", "4-1": "You may format the branch code 1 of 2 ways:\n\nFor Banco do Brasil (bank code 001) and Caixa (bank code 104): \"####-#\" - where the first 4 digits are the branch number and the final digit is the branch check digit. Example: \"3325-1\"\n\nFor all other banks: \"####\" - a 4 digit branch number. Example \"3325\"" }, "cols": 2, "rows": 5 } [/block]