{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v3/transfers/transferId:/confirm","auth":"required","method":"post","examples":{"codes":[{"language":"json","code":"//original transfer request was:\n{  \n   \"sourceAmount\":\"10\",\n   \"source\":\"account:PXTEXJ4HEPM\",\n   \"sourceCurrency\":\"USD\",\n   \"destCurrency\":\"CNY\",\n   \"dest\":\"email:sam:::at:::sendwyre.com\"\n\n}\n//response from api includes \"id\":\"MLLHFH4NELA\"\n\n//POST to /transfer/MLLHFH4NELA/confirm"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": \"TF-4F3HRUYPNFY\",\n    \"sourceAmount\": 5,\n    \"sourceCurrency\": \"USD\",\n    \"destAmount\": 0.01,\n    \"destCurrency\": \"BTC\",\n    \"status\": \"PENDING\",\n    \"message\": \"Payment for [email protected]\",\n    \"customId\": null,\n    \"exchangeRate\": 499.00,\n    \"createdAt\": 1541552388000,\n    \"fees\": {\n        \"USD\": 0.1,\n        \"BTC\": 0\n    },\n    \"totalFees\": 0.1,\n    \"completedAt\": 1541552388000,\n    \"cancelledAt\": null,\n    \"failureReason\": null,\n    \"expiresAt\": 1541553288000,\n    \"reversingSubStatus\": null,\n    \"reversalReason\": null,\n    \"pendingSubStatus\": null,\n    \"dest\": \"bitcoin:14CriXWTRoJmQdBzdikw6tEmSuwxMozWWq\",\n    \"blockchainTx\": null,\n    \"statusHistories\": [\n        {\n            \"id\": \"N88AFATLRZY\",\n            \"transferId\": \"TF-4F3HRUYPNFY\",\n            \"createdAt\": 1541552388000,\n            \"type\": \"OUTGOING\",\n            \"statusOrder\": 0,\n            \"statusDetail\": \"Initiating Transfer\",\n            \"state\": \"INITIATED\",\n            \"failedState\": null\n        },\n        {\n            \"id\": \"PED3FNLNUV7\",\n            \"transferId\": \"TF-4F3HRUYPNFY\",\n            \"createdAt\": 1541552388000,\n            \"type\": \"OUTGOING\",\n            \"statusOrder\": 200,\n            \"statusDetail\": \"Processing Exchange\",\n            \"state\": \"PENDING\",\n            \"failedState\": null\n        }\n    ],\n    \"owner\": \"account:AC-WYUR7ZZ6UMU\",\n    \"source\": \"account:AC-WYUR7ZZ6UMU\"\n}","name":""}]},"settings":"","params":[{"name":"transferId","type":"string","default":"","desc":"the ID of the transfer to confirm","required":true,"in":"path","ref":"","_id":"5be4704da9f5f50050e18f1d"}],"apiSetting":"5c50b085aae6150014b3e80e"},"next":{"description":"","pages":[]},"title":"Confirm Transfer","type":"endpoint","slug":"confirm-transfer","excerpt":"","body":"Once you've created a Transfer, and you haven't specified `autoConfirm` as true, then you will have to confirm the Transfer in order for it to process.","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5bc6350206212b0030ef1177","project":"550f74bb6fc8130d0038aad3","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"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Transfers & Exchanges","slug":"transfers","order":9,"from_sync":false,"reference":true,"_id":"5bc633b48f3ff600626e3e18","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","createdAt":"2018-10-16T18:53:40.959Z","__v":0},"user":"56ddd4424acab82000ae9d30","createdAt":"2018-10-16T18:59:14.346Z","__v":6,"parentDoc":null}

postConfirm Transfer


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

transferId:
required
string
the ID of the transfer to confirm

Examples


Result Format


Documentation

Once you've created a Transfer, and you haven't specified `autoConfirm` as true, then you will have to confirm the Transfer in order for it to process.