{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v2/transfer?customId=XXXXXXX","auth":"required","method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"// Transfer USD -> BTC Example With \"blockchainTx\" Object.\n\n{\n  \"owner\": \"account:AC_XXXXXXXX1\",\n  \"reversingSubStatus\": null,\n  \"source\": \"paymentmethod:PA_XXXXXXXX1\",\n  \"pendingSubStatus\": null,\n  \"status\": \"COMPLETED\",\n  \"reversalReason\": null,\n  \"createdAt\": 1603824914000,\n  \"sourceAmount\": 2.02,\n  \"destCurrency\": \"BTC\",\n  \"sourceCurrency\": \"USD\",\n  \"statusHistories\": [\n    {\n      \"id\": \"QXXXXXXXX\",\n      \"transferId\": \"TF_XXXXXXXX1\",\n      \"createdAt\": 1603824935000,\n      \"type\": \"OUTGOING\",\n      \"statusOrder\": 0,\n      \"statusDetail\": \"Initiating Transfer\",\n      \"state\": \"INITIATED\",\n      \"failedState\": null\n    },\n    {\n      \"id\": \"BXXXXXXXX\",\n      \"transferId\": \"TF_XXXXXXX1\",\n      \"createdAt\": 1603824935000,\n      \"type\": \"OUTGOING\",\n      \"statusOrder\": 200,\n      \"statusDetail\": \"Processing Exchange\",\n      \"state\": \"PENDING\",\n      \"failedState\": null\n    },\n    {\n      \"id\": \"9XXXXXXXX\",\n      \"transferId\": \"TF_XXXXXXXX1\",\n      \"createdAt\": 1603824936000,\n      \"type\": \"OUTGOING\",\n      \"statusOrder\": 400,\n      \"statusDetail\": \"Processing Deposit\",\n      \"state\": \"PENDING\",\n      \"failedState\": null\n    },\n    {\n      \"id\": \"TXXXXXXXX\",\n      \"transferId\": \"TF_XXXXXXXX1\",\n      \"createdAt\": 1604346618000,\n      \"type\": \"OUTGOING\",\n      \"statusOrder\": 5100,\n      \"statusDetail\": \"Transfer Completed\",\n      \"state\": \"COMPLETED\",\n      \"failedState\": null\n    }\n  ],\n  \"blockchainTx\": {\n    \"id\": \"TR_XXXXXXXX1\",\n    \"networkTxId\": \"8ba2f644f71b2eaa5edd8e421df4a0b902e...\",\n    \"createdAt\": 1604343572000,\n    \"confirmations\": 1,\n    \"timeObserved\": 1604344752000,\n    \"blockTime\": 1604346566000,\n    \"blockhash\": \"0000000000000000000299574cd707c36...\",\n    \"amount\": 0.00014529,\n    \"direction\": \"OUTGOING\",\n    \"networkFee\": 0.00066185,\n    \"address\": \"3PZsfrHEsCooPM6BC9AXWyfxxxxxxxxxx\",\n    \"sourceAddress\": null,\n    \"currency\": \"BTC\",\n    \"twinTxId\": null\n  },\n  \"expiresAt\": 1603825514000,\n  \"completedAt\": 1604346618000,\n  \"cancelledAt\": null,\n  \"failureReason\": null,\n  \"updatedAt\": 1604346617000,\n  \"exchangeRate\": 0.00007264620000000001,\n  \"destAmount\": 0.00014529,\n  \"fees\": {\n    \"BTC\": 0,\n    \"USD\": 0.02\n  },\n  \"totalFees\": 0.02,\n  \"customId\": \"xxxxxxx-1111-77777-99999-1234567896\",\n  \"dest\": \"bitcoin:3PZsfrHEsCooPM6BC9AXWyxxxxxxxxxx\",\n  \"message\": null,\n  \"id\": \"TF_XXXXXXXX1\"\n}","name":""}]},"settings":"","params":[{"name":"customId","type":"string","default":"","desc":"Custom ID of transfer to lookup","required":true,"in":"query","ref":"","_id":"6036e78bb70a7c00e3df60f4"}]},"next":{"description":"","pages":[]},"title":"Get Transfer by Custom Id","type":"endpoint","slug":"get-transfer-by-custom-id","excerpt":"","body":"Once a Transfer enters the `PENDING` state we will start moving money to the destination account. At some point the Transfer will either move to a `COMPLETED` status or a `FAILED` status asynchronously from any API call.","updates":[],"order":5,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6036e78bb70a7c00e3df60f3","createdAt":"2021-02-24T23:55:55.615Z","user":"5f7f6ea298ba660011771f74","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Transfers & Exchanges","slug":"transfers","order":7,"from_sync":false,"reference":true,"_id":"5bc633b48f3ff600626e3e18","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","createdAt":"2018-10-16T18:53:40.959Z","__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","60ef489344d5cf002cd7414d"],"_id":"550f75de61d9d30d00af9e01","__v":25,"releaseDate":"2015-03-23T02:09:34.221Z","project":"550f74bb6fc8130d0038aad3","createdAt":"2015-03-23T02:09:34.221Z","forked_from":"550f74bb6fc8130d0038aad6"},"project":"550f74bb6fc8130d0038aad3","__v":1,"parentDoc":null}

getGet Transfer by Custom Id


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

customId:
required
string
Custom ID of transfer to lookup

Result Format


Documentation

Once a Transfer enters the `PENDING` state we will start moving money to the destination account. At some point the Transfer will either move to a `COMPLETED` status or a `FAILED` status asynchronously from any API call.