{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/transfers","auth":"required","settings":"","results":{"codes":[]},"params":[{"name":"dest","type":"object","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8027"},{"name":"dest.paymentMethodType","type":"string","default":"","desc":"Must be `INTERNATIONAL_TRANSFER` - a signal to our system on how to process the dest object","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8026"},{"name":"dest.paymentType","type":"string","default":"","desc":"Which channel the funds are delivered through (e.g. 'LOCAL_BANK_TRANSFER')","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8025"},{"name":"dest.firstNameOnAccount","type":"string","default":"","desc":"Required for Individual","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8024"},{"name":"dest.lastNameOnAccount","type":"string","default":"","desc":"Required for Individual","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8023"},{"name":"dest.beneficiaryName","type":"string","default":"","desc":"Required for Business","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8022"},{"name":"dest.accountNumber","type":"string","default":"","desc":"Beneficiary account number","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8021"},{"name":"dest.clabe","type":"string","default":"","desc":"Standardized bank code for Mexico","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8020"},{"name":"dest.currency","type":"string","default":"","desc":"Currency to deposit - must match root object property destCurrency","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f801f"},{"name":"dest.country","type":"string","default":"","desc":"Country of beneficiary bank","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f801e"},{"name":"dest.beneficiaryType","type":"string","default":"","desc":"`INDIVIDUAL` or `CORPORATE`","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f801d"},{"name":"dest.nameOnAccount","type":"string","default":"","desc":"Beneficiary name","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f801c"},{"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":false,"in":"body","ref":"","_id":"5f27a326ad490202276f801b"},{"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":false,"in":"body","ref":"","_id":"5f27a326ad490202276f801a"},{"name":"sourceCurrency","type":"string","default":"","desc":"Currency to be debited from your account","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8019"},{"name":"message","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8018"},{"name":"autoConfirm","type":"string","default":"","desc":"An optional parameter to automatically confirm the transfer order.","required":false,"in":"body","ref":"","_id":"5f27a326ad490202276f8017"},{"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":"5f27a326ad490202276f8016"}],"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"}]},"method":"post"},"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":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f27a326ad490202276f8015","createdAt":"2020-08-03T05:39:50.463Z","user":"5f279b5f85a619021c4073ad","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":4,"parentDoc":null}

post🇲🇽 Payouts to Mexico


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

dest:
object
dest.paymentMethodType:
string
Must be `INTERNATIONAL_TRANSFER` - a signal to our system on how to process the dest object
dest.paymentType:
string
Which channel the funds are delivered through (e.g. 'LOCAL_BANK_TRANSFER')
dest.firstNameOnAccount:
string
Required for Individual
dest.lastNameOnAccount:
string
Required for Individual
dest.beneficiaryName:
string
Required for Business
dest.accountNumber:
string
Beneficiary account number
dest.clabe:
string
Standardized bank code for Mexico
dest.currency:
string
Currency to deposit - must match root object property destCurrency
dest.country:
string
Country of beneficiary bank
dest.beneficiaryType:
string
`INDIVIDUAL` or `CORPORATE`
dest.nameOnAccount:
string
Beneficiary name
destAmount:
string
Amount to be deposited to the dest - the amount debited from your account will be calculated automatically from the exchange rate/fees.
destCurrency:
string
Currency to be deposited to the dest. If destCurrency doesn't match the sourceCurrency an exchange will be preformed
sourceCurrency:
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]