{"_id":"59690d425d317a0029d3e4ea","project":"558b53f749dc4f0d00517de0","version":{"_id":"55909cb433090f0d004d25d8","project":"558b53f749dc4f0d00517de0","forked_from":"558b53f749dc4f0d00517de3","__v":8,"createdAt":"2015-06-29T01:17:40.214Z","releaseDate":"2015-06-29T01:17:40.214Z","categories":["55909cb433090f0d004d25d9","55909cb433090f0d004d25da","55909cb433090f0d004d25db","55909cb433090f0d004d25dc","56c72c00197f9f1700c811db","56c72df5b3625c0d00422c9e","56e1b646150ed52d0062c652","56e9fe9779708c0e002b6026","57312dc94245100e001743f4","57646a570742400e00c04701","5894c96f4d9c7e27002e42ba"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"56c72df5b3625c0d00422c9e","__v":5,"pages":["56c72e13f795cf0d003ec16a","56c72e537bb0fc0d00a973f0","56c72e77dd0b310d00e82ef1","56c72ee4862f940d00564762","56ccfdb48fa8b01b00b8202c"],"version":"55909cb433090f0d004d25d8","project":"558b53f749dc4f0d00517de0","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-19T15:00:05.865Z","from_sync":false,"order":6,"slug":"transfer-examples","title":"Payout Currencies"},"user":"5965512af0bc3f001a0a08b7","githubsync":"","__v":12,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-14T18:28:18.124Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"code":"","language":"text"}]},"method":"post","examples":{"codes":[{"language":"json","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} "}]},"auth":"required","params":[{"_id":"5a1c80439d3741002afd2d59","ref":"","in":"body","required":true,"desc":"","default":"","type":"object","name":"dest"},{"_id":"5a1c80439d3741002afd2d58","ref":"","in":"body","required":true,"desc":"Must be `INTERNATIONAL_TRANSFER` - a signal to our system on how to process the dest object","default":"","type":"string","name":"dest.paymentMethodType"},{"_id":"5a1c80439d3741002afd2d57","ref":"","in":"body","required":true,"desc":"Which channel the funds are delivered through (e.g. 'LOCAL_BANK_TRANSFER')","default":"","type":"string","name":"dest.paymentType"},{"_id":"5a1c80439d3741002afd2d56","ref":"","in":"body","required":true,"desc":"Required for Individual","default":"","type":"string","name":"dest.firstNameOnAccount"},{"_id":"5a1c80439d3741002afd2d55","ref":"","in":"body","required":true,"desc":"Required for Individual","default":"","type":"string","name":"dest.lastNameOnAccount"},{"_id":"5a1ddd3b884c8d0040a7b76d","ref":"","in":"body","required":true,"desc":"Required for Business","default":"","type":"string","name":"dest.beneficiaryName"},{"_id":"5a1c80439d3741002afd2d54","ref":"","in":"body","required":true,"desc":"Beneficiary account number","default":"","type":"string","name":"dest.accountNumber"},{"_id":"5a1c80439d3741002afd2d53","ref":"","in":"body","required":true,"desc":"Standardized bank code for Mexico","default":"","type":"string","name":"dest.clabe"},{"_id":"5a1c80439d3741002afd2d52","ref":"","in":"body","required":true,"desc":"Currency to deposit - must match root object property destCurrency","default":"","type":"string","name":"dest.currency"},{"_id":"5a1c80439d3741002afd2d51","ref":"","in":"body","required":true,"desc":"Country of beneficiary bank","default":"","type":"string","name":"dest.country"},{"_id":"5a1c80439d3741002afd2d50","ref":"","in":"body","required":true,"desc":"`INDIVIDUAL` or `CORPORATE`","default":"","type":"string","name":"dest.beneficiaryType"},{"_id":"5a1c80439d3741002afd2d4f","ref":"","in":"body","required":false,"desc":"Beneficiary name","default":"","type":"string","name":"dest.nameOnAccount"},{"_id":"5a1c80439d3741002afd2d4e","ref":"","in":"body","required":true,"desc":"Amount to be deposited to the dest - the amount debited from your account will be calculated automatically from the exchange rate/fees.","default":"","type":"float","name":"destAmount"},{"_id":"5a1c80439d3741002afd2d4d","ref":"","in":"body","required":true,"desc":"Currency to be deposited to the dest. If destCurrency doesn't match the sourceCurrency an exchange will be preformed","default":"","type":"string","name":"destCurrency"},{"_id":"5a1c80439d3741002afd2d4c","ref":"","in":"body","required":true,"desc":"Currency to be debited from your account","default":"","type":"string","name":"sourceCurrency"},{"_id":"5a1c80439d3741002afd2d4b","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"message"},{"_id":"5a26e9cbebdd09002892979e","ref":"","in":"body","required":false,"desc":"An optional parameter to automatically confirm the transfer order.","default":"","type":"string","name":"autoConfirm"},{"_id":"5a26e9cbebdd09002892979d","ref":"","in":"body","required":false,"desc":"An optional url that Wyre will POST a status callback to (see [Callbacks](doc:callbacks))","default":"","type":"string","name":"callbackUrl"}],"url":"/transfers"},"isReference":false,"order":4,"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]","excerpt":"","slug":"payouts-to-mexico","type":"endpoint","title":"Payouts to 🇲🇽 MEXICO"}

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]