{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v2/transfer/:transferId","auth":"required","method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": \"TF_N8UPM3MUYGT\",\n    \"status\": \"PENDING\",\n    \"failureReason\": null,\n    \"language\": \"en\",\n    \"createdAt\": 1612987706000,\n    \"updatedAt\": null,\n    \"completedAt\": null,\n    \"depositInitiatedAt\": 1612987710000,\n    \"cancelledAt\": null,\n    \"expiresAt\": 1612988606000,\n    \"submitter\": \"account:AC_XXXXXXXXXX\",\n    \"owner\": \"account:AC_XXXXXXXXXX\",\n    \"source\": \"paymentmethod:PA_TXM6WTN88HG\",\n    \"dest\": \"account:AC_YNWFWXDW3AG\",\n    \"sourceCurrency\": \"USD\",\n    \"sourceAmount\": 1E+2,\n    \"destCurrency\": \"USD\",\n    \"destAmount\": 1E+2,\n    \"atMinFee\": false,\n    \"exchangeRate\": null,\n    \"desc\": null,\n    \"message\": \"USD Wire Transfer\",\n    \"totalFees\": 0,\n    \"equivalencies\": {\n        \"CLP\": 73329.84,\n        \"AUD\": 129.40,\n        \"LINK\": 3.772161448509996005,\n        \"ARS\": 8826.13,\n        \"GBP\": 72.50,\n        \"INR\": 7286.98,\n        \"COMP\": 0.208528829110624539,\n        \"PAX\": 100.000000000000000000,\n        \"HUSD\": 100.00000000,\n        \"LBTC\": 0.002136,\n        \"BTC\": 0.00213707,\n        \"TRY\": 707.52,\n        \"CRV\": 31.446540880503143073,\n        \"UMA\": 3.514938488576450000,\n        \"CHF\": 89.26,\n        \"JPY\": 10458,\n        \"USDS\": 100.000000,\n        \"ISK\": 12764.01,\n        \"COP\": 357630.00,\n        \"WBTC\": 0.00215027,\n        \"HKD\": 775.17,\n        \"NOK\": 846.06,\n        \"CZK\": 2125.93,\n        \"AAVE\": 0.204658016454504521,\n        \"MKR\": 0.039828577801143873,\n        \"UNI\": 5.154639175257732336,\n        \"PLN\": 369.74,\n        \"SNX\": 4.280821917808219282,\n        \"NZD\": 138.22,\n        \"KRW\": 111154,\n        \"MXN\": 2009.67,\n        \"BUSD\": 100.000000000000000000,\n        \"CNY\": 643.53,\n        \"GUSD\": 100.00,\n        \"THB\": 2991.03,\n        \"YFI\": 0.003047691495599743,\n        \"USD\": 100.00,\n        \"USDC\": 100.000000,\n        \"DKK\": 614.38,\n        \"MYR\": 404.90,\n        \"CAD\": 127.08,\n        \"ZAR\": 1476.98,\n        \"BAT\": 43.859649122807021303,\n        \"PHP\": 4805.85,\n        \"USDT\": 100.000000,\n        \"DAI\": 100.000000000000000000,\n        \"ILS\": 324.98,\n        \"BRL\": 536.65,\n        \"EUR\": 82.61,\n        \"SGD\": 132.69,\n        \"ETH\": 0.057306590257879656,\n        \"SEK\": 833.51\n    },\n    \"feeEquivalencies\": {\n        \"CLP\": 0.00,\n        \"AUD\": 0.00,\n        \"LINK\": 0E-18,\n        \"ARS\": 0.00,\n        \"GBP\": 0.00,\n        \"INR\": 0.00,\n        \"COMP\": 0E-18,\n        \"PAX\": 0E-18,\n        \"HUSD\": 0E-8,\n        \"LBTC\": 0.000000,\n        \"BTC\": 0E-8,\n        \"TRY\": 0.00,\n        \"CRV\": 0E-18,\n        \"UMA\": 0E-18,\n        \"CHF\": 0.00,\n        \"JPY\": 0,\n        \"USDS\": 0.000000,\n        \"ISK\": 0.00,\n        \"COP\": 0.00,\n        \"WBTC\": 0E-8,\n        \"HKD\": 0.00,\n        \"NOK\": 0.00,\n        \"CZK\": 0.00,\n        \"AAVE\": 0E-18,\n        \"MKR\": 0E-18,\n        \"UNI\": 0E-18,\n        \"PLN\": 0.00,\n        \"SNX\": 0E-18,\n        \"NZD\": 0.00,\n        \"KRW\": 0,\n        \"MXN\": 0.00,\n        \"BUSD\": 0E-18,\n        \"CNY\": 0.00,\n        \"GUSD\": 0.00,\n        \"THB\": 0.00,\n        \"YFI\": 0E-18,\n        \"USD\": 0.00,\n        \"USDC\": 0.000000,\n        \"DKK\": 0.00,\n        \"MYR\": 0.00,\n        \"CAD\": 0.00,\n        \"ZAR\": 0.00,\n        \"BAT\": 0E-18,\n        \"PHP\": 0.00,\n        \"USDT\": 0.000000,\n        \"DAI\": 0E-18,\n        \"ILS\": 0.00,\n        \"BRL\": 0.00,\n        \"EUR\": 0.00,\n        \"SGD\": 0.00,\n        \"ETH\": 0E-18,\n        \"SEK\": 0.00\n    },\n    \"fees\": {\n        \"USD\": 0.00\n    },\n    \"feeScheduleOverride\": null,\n    \"authorizingIp\": \"76.168.33.245\",\n    \"paymentUrl\": null,\n    \"exchangeOrderId\": null,\n    \"inExchangeId\": null,\n    \"chargeId\": \"7F2ZNT97H9M\",\n    \"depositId\": null,\n    \"sourceTxId\": \"F8WVNTZCRU6\",\n    \"destTxId\": \"TF_N8UPM3MUYGT-D\",\n    \"customId\": null,\n    \"buy\": false,\n    \"instantBuy\": false,\n    \"sell\": false,\n    \"exchange\": false,\n    \"send\": false,\n    \"deposit\": true,\n    \"withdrawal\": false,\n    \"closed\": false,\n    \"reversingSubStatus\": null,\n    \"reversalReason\": null,\n    \"retrievalUrl\": \"https://www.testwyre.com//sign-in\",\n    \"quotedMargin\": null,\n    \"originatorOfacStatus\": \"DISABLED\",\n    \"beneficiaryOfacStatus\": \"DISABLED\",\n    \"originatorUnSanctionsStatus\": \"DISABLED\",\n    \"beneficiaryUnSanctionsStatus\": \"DISABLED\",\n    \"ellipticRiskScore\": null,\n    \"ellipticRiskRuleName\": null,\n    \"destNickname\": null,\n    \"pendingSubStatus\": \"PROCESSING_CHARGE\",\n    \"destName\": \"Nick Teixeira\",\n    \"sourceName\": \"USD Bank account ending in 0000\",\n    \"exchangeOrder\": null,\n    \"inExchange\": null,\n    \"estimatedArrival\": 1612987897273,\n    \"blockchainTx\": null,\n    \"statusHistories\": [\n        {\n            \"id\": \"U32V2BMFGDH\",\n            \"transferId\": \"TF_N8UPM3MUYGT\",\n            \"createdAt\": 1612987708000,\n            \"type\": \"OUTGOING\",\n            \"statusOrder\": 0,\n            \"statusDetail\": \"Initiating Transfer\",\n            \"state\": \"INITIATED\",\n            \"failedState\": null\n        },\n        {\n            \"id\": \"FFUQGLEFUHH\",\n            \"transferId\": \"TF_N8UPM3MUYGT\",\n            \"createdAt\": 1612987709000,\n            \"type\": \"OUTGOING\",\n            \"statusOrder\": 400,\n            \"statusDetail\": \"Processing Deposit\",\n            \"state\": \"PENDING\",\n            \"failedState\": null\n        }\n    ],\n    \"documents\": [],\n    \"pusherChannel\": \"d8d22a98e0f8c00e380d3a67ace0baf1\",\n    \"reversalRevenue\": null,\n    \"reversalRevenueCurrency\": null,\n    \"depositInfo\": null,\n    \"chargeInfo\": {\n        \"id\": \"7F2ZNT97H9M\",\n        \"paymentMethodId\": \"PA_TXM6WTN88HG\",\n        \"providerId\": \"7F2ZNT97H9M\",\n        \"createdAt\": 1612987709000,\n        \"updatedAt\": 1612987709000,\n        \"currency\": \"USD\",\n        \"amount\": 1E+2,\n        \"fees\": 0,\n        \"txId\": \"F8WVNTZCRU6\",\n        \"owner\": \"account:AC_YNWFWXDW3AG\",\n        \"callerIp\": \"76.168.33.245\",\n        \"completePaymentUrl\": null,\n        \"completionExpectedAt\": null,\n        \"providerData\": {\n            \"id\": \"FFYL36W2MLW\",\n            \"createdAt\": 1553120922000,\n            \"supportedCountries\": [\n                \"US\"\n            ],\n            \"supportedCurrencies\": [\n                \"USD\"\n            ],\n            \"country\": \"US\",\n            \"priority\": 1,\n            \"instructions\": \"You can complete the transfer by following these steps:\\n\\n1.) Print or download the details\\n2.) Send the exact amount to the bank details listed above (You can send money through online banking or mobile banking, etc.)\\n3.) You will receive an email notification with the transfer details\",\n            \"bankAddress\": \"Evolve Bank and Trust\\n6070 Poplar Ave\\n#100\\nMemphis, TN 38119\",\n            \"bankPhone\": \"866.395.2754\",\n            \"routingNumber\": \"084106768\",\n            \"accountNumber\": \"9827813073\",\n            \"beneficiary\": \"Wyre Payments, Inc. FBO Users\",\n            \"beneficiaryAddress\": \"6070 Poplar Ave\\n#100\\nMemphis, TN 38119\",\n            \"intermediaryBank\": null,\n            \"swiftCode\": null,\n            \"abaNumber\": null,\n            \"city\": null,\n            \"branchCode\": null,\n            \"accountType\": null,\n            \"accountId\": \"AC_YNWFWXDW3AG\",\n            \"iban\": null,\n            \"label\": \"Evolve Bank and (US 9827813073) \"\n        },\n        \"waitingPrompts\": [],\n        \"cancelReason\": null,\n        \"batchId\": null,\n        \"needsAttention\": false,\n        \"linkType\": \"INTERNATIONAL_TRANSFER\",\n        \"failedReason\": null,\n        \"wireDetails\": {\n            \"instructions\": \"You can complete the transfer by following these steps:\\n\\n1.) Print or download the details\\n2.) Send the exact amount to the bank details listed above (You can send money through online banking or mobile banking, etc.)\\n3.) You will receive an email notification with the transfer details\",\n            \"bankAddress\": \"Evolve Bank and Trust\\n6070 Poplar Ave\\n#100\\nMemphis, TN 38119\",\n            \"bankPhone\": \"866.395.2754\",\n            \"routingNumber\": \"084106768\",\n            \"accountNumber\": \"9827813073\",\n            \"beneficiary\": \"Wyre Payments, Inc. FBO Users\",\n            \"beneficiaryAddress\": \"6070 Poplar Ave\\n#100\\nMemphis, TN 38119\",\n            \"intermediaryBank\": null,\n            \"swiftCode\": null,\n            \"abaNumber\": null,\n            \"city\": null,\n            \"branchCode\": null,\n            \"country\": \"US\",\n            \"accountType\": null,\n            \"iban\": null\n        },\n        \"rawStatus\": \"PENDING\",\n        \"status\": \"PENDING\"\n    }\n}","name":""}]},"settings":"","params":[{"name":"transferId","type":"string","default":"","desc":"Example: TF_N8UPM3MUYGT","required":true,"in":"path","ref":"","_id":"602443ec7e0db9003b93de21"}]},"next":{"description":"","pages":[]},"title":"Wire Transfer Deposit","type":"endpoint","slug":"wire-transfer-deposit","excerpt":"Wire transfer funds into a Wyre account","body":"Please refer your users to the `wireDetails` node in the response. This will provide instructions on how to send a wire transfer to Wyre. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// Sample extracted from the full response above\\n\\\"wireDetails\\\": {\\n            \\\"instructions\\\": \\\"You can complete the transfer by following these steps:\\\\n\\\\n1.) Print or download the details\\\\n2.) Send the exact amount to the bank details listed above (You can send money through online banking or mobile banking, etc.)\\\\n3.) You will receive an email notification with the transfer details\\\",\\n            \\\"bankAddress\\\": \\\"Evolve Bank and Trust\\\\n6070 Poplar Ave\\\\n#100\\\\nMemphis, TN 38119\\\",\\n            \\\"bankPhone\\\": \\\"866.395.2754\\\",\\n            \\\"routingNumber\\\": \\\"084106768\\\",\\n            \\\"accountNumber\\\": \\\"9827813073\\\",\\n            \\\"beneficiary\\\": \\\"Wyre Payments, Inc. FBO Users\\\",\\n            \\\"beneficiaryAddress\\\": \\\"6070 Poplar Ave\\\\n#100\\\\nMemphis, TN 38119\\\",\\n            \\\"intermediaryBank\\\": null,\\n            \\\"swiftCode\\\": null,\\n            \\\"abaNumber\\\": null,\\n            \\\"city\\\": null,\\n            \\\"branchCode\\\": null,\\n            \\\"country\\\": \\\"US\\\",\\n            \\\"accountType\\\": null,\\n            \\\"iban\\\": null\\n},\",\n      \"language\": \"json\",\n      \"name\": \"wireDetails response\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Creating a Wire Deposit Transfer\"\n}\n[/block]\nThis process starts as a transfer request using [Create Transfer](doc:create-transfer) with a non-ACH payment method as the source like the example below.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"source\\\":\\\"paymentMethod:PA_TXM6WTN88HG\\\",\\n  \\\"dest\\\":\\\"account:AC_YNWFWXDW3AG\\\",\\n  \\\"sourceCurrency\\\":\\\"USD\\\",\\n  \\\"destCurrency\\\":\\\"USD\\\",\\n  \\\"destAmount\\\":100,\\n  \\\"message\\\":\\\"USD Wire Transfer\\\",\\n  \\\"autoConfirm\\\":true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Initial Transfer Request\"\n    }\n  ]\n}\n[/block]\nThe create transfer event sends a response that includes the transfer id, like below:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"//Truncated response for example\\n{\\n    \\\"id\\\": \\\"TF_BVETD6PZA7W\\\",\\n    \\\"status\\\": \\\"UNCONFIRMED\\\",\\n    \\\"failureReason\\\": null,\\n    \\\"language\\\": \\\"en\\\",\\n    \\\"createdAt\\\": 1611869941434,\\n    \\\"updatedAt\\\": null,\\n    \\\"completedAt\\\": null,\\n    \\\"depositInitiatedAt\\\": null,\\n    \\\"cancelledAt\\\": null,\\n    \\\"expiresAt\\\": 1611870841434,\\n    \\\"submitter\\\": \\\"account:AC_XXXXXXXXXX\\\",\\n    \\\"owner\\\": \\\"account:AC_XXXXXXXXXX\\\",\\n    \\\"source\\\": \\\"paymentmethod:PA_MXAUE736A9T\\\",\\n    \\\"dest\\\": \\\"account:AC_XXXXXXXXXX\\\",\\n    \\\"sourceCurrency\\\": \\\"USD\\\",\\n    \\\"sourceAmount\\\": 200.00,\\n    \\\"destCurrency\\\": \\\"USD\\\",\\n    \\\"destAmount\\\": 200.00,\\n    \\\"atMinFee\\\": false,\\n    \\\"exchangeRate\\\": null,\\n    \\\"desc\\\": \\\"Unconfirmed: Transfer of $200.00 to account:AC_XXXXXXXXXX\\\",\\n    \\\"message\\\": \\\"USD Personal example\\\",\\n    \\\"totalFees\\\": 0.00\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Transfer Response\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Getting the Wire Instructions\"\n}\n[/block]\nThe GET endpoint on this page `/v2/transfer/:transferId` is used to retrieve the wire instruction details. You will provide the transfer id in the path of the GET request in order to receive the wire instructions in the response.","updates":[],"order":6,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"602443ec7e0db9003b93de20","createdAt":"2021-02-10T20:37:00.849Z","user":"5f7f6ea298ba660011771f74","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Payment Methods","slug":"payment-methods","order":10,"from_sync":false,"reference":true,"_id":"5bc633b08c4b0b000d6a7eaa","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","createdAt":"2018-10-16T18:53:36.184Z","__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","5f9a2cb79dafe500259281a7","5fd92bf362bb7301b00e48ba"],"_id":"550f75de61d9d30d00af9e01","__v":24,"releaseDate":"2015-03-23T02:09:34.221Z","project":"550f74bb6fc8130d0038aad3","createdAt":"2015-03-23T02:09:34.221Z","forked_from":"550f74bb6fc8130d0038aad6"},"project":"550f74bb6fc8130d0038aad3","__v":0,"parentDoc":null}

getWire Transfer Deposit

Wire transfer funds into a Wyre account

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

transferId:
required
string
Example: TF_N8UPM3MUYGT

Result Format


Documentation

Please refer your users to the `wireDetails` node in the response. This will provide instructions on how to send a wire transfer to Wyre. [block:code] { "codes": [ { "code": "// Sample extracted from the full response above\n\"wireDetails\": {\n \"instructions\": \"You can complete the transfer by following these steps:\\n\\n1.) Print or download the details\\n2.) Send the exact amount to the bank details listed above (You can send money through online banking or mobile banking, etc.)\\n3.) You will receive an email notification with the transfer details\",\n \"bankAddress\": \"Evolve Bank and Trust\\n6070 Poplar Ave\\n#100\\nMemphis, TN 38119\",\n \"bankPhone\": \"866.395.2754\",\n \"routingNumber\": \"084106768\",\n \"accountNumber\": \"9827813073\",\n \"beneficiary\": \"Wyre Payments, Inc. FBO Users\",\n \"beneficiaryAddress\": \"6070 Poplar Ave\\n#100\\nMemphis, TN 38119\",\n \"intermediaryBank\": null,\n \"swiftCode\": null,\n \"abaNumber\": null,\n \"city\": null,\n \"branchCode\": null,\n \"country\": \"US\",\n \"accountType\": null,\n \"iban\": null\n},", "language": "json", "name": "wireDetails response" } ] } [/block] [block:api-header] { "title": "Creating a Wire Deposit Transfer" } [/block] This process starts as a transfer request using [Create Transfer](doc:create-transfer) with a non-ACH payment method as the source like the example below. [block:code] { "codes": [ { "code": "{\n \"source\":\"paymentMethod:PA_TXM6WTN88HG\",\n \"dest\":\"account:AC_YNWFWXDW3AG\",\n \"sourceCurrency\":\"USD\",\n \"destCurrency\":\"USD\",\n \"destAmount\":100,\n \"message\":\"USD Wire Transfer\",\n \"autoConfirm\":true\n}", "language": "json", "name": "Initial Transfer Request" } ] } [/block] The create transfer event sends a response that includes the transfer id, like below: [block:code] { "codes": [ { "code": "//Truncated response for example\n{\n \"id\": \"TF_BVETD6PZA7W\",\n \"status\": \"UNCONFIRMED\",\n \"failureReason\": null,\n \"language\": \"en\",\n \"createdAt\": 1611869941434,\n \"updatedAt\": null,\n \"completedAt\": null,\n \"depositInitiatedAt\": null,\n \"cancelledAt\": null,\n \"expiresAt\": 1611870841434,\n \"submitter\": \"account:AC_XXXXXXXXXX\",\n \"owner\": \"account:AC_XXXXXXXXXX\",\n \"source\": \"paymentmethod:PA_MXAUE736A9T\",\n \"dest\": \"account:AC_XXXXXXXXXX\",\n \"sourceCurrency\": \"USD\",\n \"sourceAmount\": 200.00,\n \"destCurrency\": \"USD\",\n \"destAmount\": 200.00,\n \"atMinFee\": false,\n \"exchangeRate\": null,\n \"desc\": \"Unconfirmed: Transfer of $200.00 to account:AC_XXXXXXXXXX\",\n \"message\": \"USD Personal example\",\n \"totalFees\": 0.00\n}", "language": "json", "name": "Transfer Response" } ] } [/block] [block:api-header] { "title": "Getting the Wire Instructions" } [/block] The GET endpoint on this page `/v2/transfer/:transferId` is used to retrieve the wire instruction details. You will provide the transfer id in the path of the GET request in order to receive the wire instructions in the response.