{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v2/transfers","auth":"required","settings":"","results":{"codes":[{"name":"","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","status":200}]},"params":[{"name":"dest","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f062319b"},{"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":"5f27a197f61fb601f062319a"},{"name":"dest.country","type":"string","default":"","desc":"`CN`","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623199"},{"name":"dest.currency","type":"string","default":"","desc":"Currency to deposit - must match root object property `destCurrency`","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623198"},{"name":"dest.beneficiaryType","type":"string","default":"","desc":"`INDIVIDUAL` or `CORPORATE`","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623197"},{"name":"dest.paymentType","type":"string","default":"","desc":"Which channel the funds are delivered through - \"LOCAL_BANK_TRANSFER\" is currently the only supported value for China","required":false,"in":"body","ref":"","_id":"5f27a197f61fb601f0623196"},{"name":"dest.branchCode","type":"string","default":"","desc":"Beneficiary branch code (see formatting rules below)","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623195"},{"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":"5f27a197f61fb601f0623194"},{"name":"dest.nameOnAccount","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623193"},{"name":"dest.bankName","type":"string","default":"","desc":"Beneficiary bank name","required":true,"in":"body","ref":"","_id":"5f27a3c0c35eb4004d0c7d1a"},{"name":"dest.accountType","type":"string","default":"","desc":"`corrente`","required":false,"in":"body","ref":"","_id":"5f27a197f61fb601f0623192"},{"name":"dest.bankCode","type":"string","default":"","desc":"Beneficiary bank code; [Supported BR Bank Codes](https://api.sendwyre.com/v2/bankinfo/BR)","required":false,"in":"body","ref":"","_id":"5f27a3c0c35eb4004d0c7d18"},{"name":"dest.cpfCnpj","type":"string","default":"","desc":"Brazilian tax identification numbers","required":false,"in":"body","ref":"","_id":"5f27a197f61fb601f0623191"},{"name":"dest.accountHolderPhoneNumber","type":"string","default":"","desc":"Beneficiary phone number","required":true,"in":"body","ref":"","_id":"5f27a197f61fb601f0623190"},{"name":"sourceCurrency","type":"string","default":"","desc":"Currency to be debited from your account","required":true,"in":"body","ref":"","_id":"5f27a196f61fb601f062318f"},{"name":"destCurrency","type":"string","default":"","desc":"Currency to be deposited to the dest. If destCurrency doesn't match the sourceCurrency an exchange will be preformed","required":true,"in":"body","ref":"","_id":"5f27a196f61fb601f062318e"},{"name":"destAmount","type":"string","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":"5f27a196f61fb601f062318d"},{"name":"message","type":"string","default":"","desc":"Optional message for transactions","required":false,"in":"body","ref":"","_id":"5f27a196f61fb601f062318c"},{"name":"autoConfirm","type":"string","default":"","desc":"An optional parameter to automatically confirm the transfer order.","required":false,"in":"body","ref":"","_id":"5f27a196f61fb601f062318a"},{"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":"5f27a196f61fb601f0623189"}],"examples":{"codes":[]},"method":"post"},"next":{"description":"","pages":[]},"title":"πŸ‡§πŸ‡· Payouts to Brazil","type":"endpoint","slug":"payouts-to-brazil","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":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f27a2f83cf43b0250ef0c1e","createdAt":"2020-08-03T05:39:04.053Z","user":"54ea9905a6f14f0d003e96e7","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Global Payouts","slug":"global-payouts","order":11,"from_sync":false,"reference":false,"_id":"5f276fd300e519001139200a","createdAt":"2020-08-03T02:00:51.725Z","version":"550f75de61d9d30d00af9e01","project":"550f74bb6fc8130d0038aad3","__v":0},"version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded","5e8127d61c906800374eeb1c","5f2768c98622b8005106544a","5f2768d05702ca0011f7655e","5f276e5348d2b600321aef9b","5f276fd300e519001139200a"],"_id":"550f75de61d9d30d00af9e01","__v":22,"releaseDate":"2015-03-23T02:09:34.221Z","project":"550f74bb6fc8130d0038aad3","createdAt":"2015-03-23T02:09:34.221Z","forked_from":"550f74bb6fc8130d0038aad6"},"project":"550f74bb6fc8130d0038aad3","__v":2,"parentDoc":null}

postπŸ‡§πŸ‡· Payouts to Brazil


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

dest:
required
string
dest.paymentMethodType:
required
string
Must be `INTERNATIONAL_TRANSFER` - a signal to our system on how to process the dest object
dest.country:
required
string
`CN`
dest.currency:
required
string
Currency to deposit - must match root object property `destCurrency`
dest.beneficiaryType:
required
string
`INDIVIDUAL` or `CORPORATE`
dest.paymentType:
string
Which channel the funds are delivered through - "LOCAL_BANK_TRANSFER" is currently the only supported value for China
dest.branchCode:
required
string
Beneficiary branch code (see formatting rules below)
dest.accountNumber:
required
string
All account numbers require the check digit. The check digit is the number after the `-` in the account number.
dest.nameOnAccount:
required
string
dest.bankName:
required
string
Beneficiary bank name
dest.accountType:
string
`corrente`
dest.bankCode:
string
Beneficiary bank code; [Supported BR Bank Codes](https://api.sendwyre.com/v2/bankinfo/BR)
dest.cpfCnpj:
string
Brazilian tax identification numbers
dest.accountHolderPhoneNumber:
required
string
Beneficiary phone number
sourceCurrency:
required
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 preformed
destAmount:
required
string
Amount to be deposited to the dest - the amount debited from your account will be calculated automatically from the exchange rate/fees.
message:
string
Optional message for transactions
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))

Result Format


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]