{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/transfers","auth":"required","settings":"","results":{"codes":[{"language":"text","code":""}]},"method":"post","examples":{"codes":[{"code":"{\n    \"source\":\"account:AC-0000000000\",\n    \"dest\":\n    {\n    \"paymentMethodType\":\"INTERNATIONAL_TRANSFER\",\n    \"paymentType\":\"LOCAL_BANK_TRANSFER\",\n    \"firstNameOnAccount\":\"Veronica\",\n    \"lastNameOnAccount\":\"UB\",\n    \"accountNumber\":\"0000000000\",\n    \"clabe\":\"0000000000\",\n    \"currency\":\"MXN\",\n    \"country\":\"MX\",\n    \"beneficiaryType\":\"INDIVIDUAL\",    \n    \"nameOnAccount\":\"personal account\"\n    },\n    \"destAmount\": 721.10,\n    \"destCurrency\": \"MXN\",\n    \"sourceCurrency\": \"USD\",\n    \"autoConfirm\": true,\n    \"message\": \"MXN example\"\n} ","language":"json"}]},"params":[{"name":"dest","type":"object","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d59"},{"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":"5a1c80439d3741002afd2d58"},{"name":"dest.paymentType","type":"string","default":"","desc":"Which channel the funds are delivered through (e.g. 'LOCAL_BANK_TRANSFER')","required":true,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d57"},{"name":"dest.firstNameOnAccount","type":"string","default":"","desc":"Required for Individual","required":true,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d56"},{"name":"dest.lastNameOnAccount","type":"string","default":"","desc":"Required for Individual","required":true,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d55"},{"name":"dest.beneficiaryName","type":"string","default":"","desc":"Required for Business","required":true,"in":"body","ref":"","_id":"5a1ddd3b884c8d0040a7b76d"},{"name":"dest.accountNumber","type":"string","default":"","desc":"Beneficiary account number","required":true,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d54"},{"name":"dest.clabe","type":"string","default":"","desc":"Standardized bank code for Mexico","required":true,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d53"},{"name":"dest.currency","type":"string","default":"","desc":"Currency to deposit - must match root object property destCurrency","required":true,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d52"},{"name":"dest.country","type":"string","default":"","desc":"Country of beneficiary bank","required":true,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d51"},{"name":"dest.beneficiaryType","type":"string","default":"","desc":"`INDIVIDUAL` or `CORPORATE`","required":true,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d50"},{"name":"dest.nameOnAccount","type":"string","default":"","desc":"Beneficiary name","required":false,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d4f"},{"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":"5a1c80439d3741002afd2d4e"},{"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":"5a1c80439d3741002afd2d4d"},{"name":"sourceCurrency","type":"string","default":"","desc":"Currency to be debited from your account","required":true,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d4c"},{"name":"message","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a1c80439d3741002afd2d4b"},{"name":"autoConfirm","type":"string","default":"","desc":"An optional parameter to automatically confirm the transfer order.","required":false,"in":"body","ref":"","_id":"5a26e9cbebdd09002892979e"},{"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":"5a26e9cbebdd09002892979d"}]},"next":{"description":"","pages":[]},"title":"Payouts to 🇲🇽 MEXICO","type":"endpoint","slug":"payouts-to-mexico","excerpt":"","body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"**Payout Options**\",\n    \"0-1\": \"SPEI - SPEI is Mexico’s lightning fast and inexpensive inter-bank transfer system (akin to SEPA in Europe, and vastly superior to ACH). All bank accounts in Mexico can be identified by their special 18-digit SPEI account number, otherwise known as a ‘CLABE’. Transfers executed via SPEI are typically concluded within a few seconds (within banking hours).\\n\\nDebit Cards - Send tansfers directly to debit cards from any mexican bank. Note that the “institution_code” is obtained from the bank_codes endpoint.\",\n    \"1-0\": \"**Banking Coverage**\",\n    \"1-1\": \"See entire bank list here: https://en.wikipedia.org/wiki/CLABE\",\n    \"2-0\": \"**Delivery Time**\",\n    \"2-1\": \"Triggers a SPEI + DEBIT CARD withdrawal from your account. These withdrawals are immediate during banking hours for some banks (M-F 9:00AM - 5:00PM Mexico City Time), 24 hours for others.\",\n    \"3-0\": \"**Limits**\",\n    \"3-1\": \"Minimum is $50MXN, no maximum currently.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59690d425d317a0029d3e4ea","project":"558b53f749dc4f0d00517de0","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},"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"},"user":"5965512af0bc3f001a0a08b7","createdAt":"2017-07-14T18:28:18.124Z","githubsync":"","__v":12,"parentDoc":null}

postPayouts to 🇲🇽 MEXICO


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.paymentType:
required
string
Which channel the funds are delivered through (e.g. 'LOCAL_BANK_TRANSFER')
dest.firstNameOnAccount:
required
string
Required for Individual
dest.lastNameOnAccount:
required
string
Required for Individual
dest.beneficiaryName:
required
string
Required for Business
dest.accountNumber:
required
string
Beneficiary account number
dest.clabe:
required
string
Standardized bank code for Mexico
dest.currency:
required
string
Currency to deposit - must match root object property destCurrency
dest.country:
required
string
Country of beneficiary bank
dest.beneficiaryType:
required
string
`INDIVIDUAL` or `CORPORATE`
dest.nameOnAccount:
string
Beneficiary name
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.
destCurrency:
required
string
Currency to be deposited to the dest. If destCurrency doesn't match the sourceCurrency an exchange will be preformed
sourceCurrency:
required
string
Currency to be debited from your account
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": "SPEI - SPEI is Mexico’s lightning fast and inexpensive inter-bank transfer system (akin to SEPA in Europe, and vastly superior to ACH). All bank accounts in Mexico can be identified by their special 18-digit SPEI account number, otherwise known as a ‘CLABE’. Transfers executed via SPEI are typically concluded within a few seconds (within banking hours).\n\nDebit Cards - Send tansfers directly to debit cards from any mexican bank. Note that the “institution_code” is obtained from the bank_codes endpoint.", "1-0": "**Banking Coverage**", "1-1": "See entire bank list here: https://en.wikipedia.org/wiki/CLABE", "2-0": "**Delivery Time**", "2-1": "Triggers a SPEI + DEBIT CARD withdrawal from your account. These withdrawals are immediate during banking hours for some banks (M-F 9:00AM - 5:00PM Mexico City Time), 24 hours for others.", "3-0": "**Limits**", "3-1": "Minimum is $50MXN, no maximum currently." }, "cols": 2, "rows": 4 } [/block]