{"_id":"5d1d9ab447822c013328b7f4","version":{"_id":"56326e9cdf556c0d00cd08ca","project":"544fc17e698ab40800b4f891","__v":22,"createdAt":"2015-10-29T19:08:12.724Z","releaseDate":"2015-10-29T19:08:12.724Z","categories":["56326e9ddf556c0d00cd08cb","56326e9ddf556c0d00cd08cc","56326e9ddf556c0d00cd08cd","56326e9ddf556c0d00cd08ce","56326e9ddf556c0d00cd08cf","56326e9ddf556c0d00cd08d0","56326e9ddf556c0d00cd08d1","56326e9ddf556c0d00cd08d2","56326e9ddf556c0d00cd08d3","56326e9ddf556c0d00cd08d4","56d942ac337fd11300d6a251","5ab2fcf66a1d77001230b47e","5afc2943bd2ef4000330bca7","5d1d87419a969a00141c6b4c","5d1d8948ef26b2002c6468d1","5d1d8afe7b2b24005bec7de0","5d1d8b24f5cfcb00201490bb","5d1d8bb82d46d1004a02581f","5d1d8de1e4edb0019ed63acd","5d1d8f6b613fb90050d0d3e0","5d1d934ed377870191039d28","5d1d99810b2e4600500eb5ff","5d1da14e613fb90050d0d491","5d229a846cf323005a7fa998","5d229a8c8abf65001cc4768d","5d229a9494b856002e26b6e1","5d229a9bf77bb900507ccb04","5d229aa88abf65001cc4768e","5d24310a9ca8c80054786177","5d24359101cc3a00508e7482","5d24418fa791b20050733b32"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"collector","version_clean":"2.1.0","version":"2.1"},"updatedAt":"2019-07-04T07:56:23.230Z","project":"544fc17e698ab40800b4f891","category":{"_id":"5d1d99810b2e4600500eb5ff","project":"544fc17e698ab40800b4f891","version":"56326e9cdf556c0d00cd08ca","isAPI":false,"__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2019-07-04T06:15:29.680Z","from_sync":false,"order":21,"slug":"wallets-1","title":"Wallets"},"user":"5d19a189b4596f0072f571d4","__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-07-04T06:20:36.183Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"5d1d8bb82d46d1004a02581d","examples":{"codes":[{"code":"import requests\n\nTOKEN = 'YOUR TOKEN'\nurl = 'https://coins.ph/api/v3/transfers'\n\nheaders = {\n    'Authorization': 'Bearer {}'.format(TOKEN),\n    'Accept': 'application/json'\n}\n\nrequests.get(url, headers=headers)","language":"python"}]},"results":{"codes":[{"name":"","code":"{\n    \"transfer\": {\n        \"id\":\"1b\",\n        \"account\":\"2a\",\n        \"amount\":\"0.00010000\",\n        \"target_address\":\"address\",\n        \"payment\": \"e539a\",\n        \"exchange\": \"BTC-PHP\",\n        \"status\":\"success\",\n        \"created_at\":\"2014-08-28T12:11:36.938Z\"\n    }\n}","language":"json","status":200}]},"method":"get","auth":"required","params":[{"_id":"5d1d9ab447822c013328b7f6","ref":"","in":"path","required":false,"desc":"Optional. ID of the transfer record to retrieve. If not provided, the endpoint will return the `transfers` history.","default":"","type":"string","name":"id"},{"_id":"5d1d9ab447822c013328b7f5","ref":"","in":"query","required":false,"desc":"A transaction ID provided by the API user. Usually, this transaction ID refers to a transaction in the API user's system.","default":"","type":"string","name":"reference__external_transaction_id"}],"url":"/api/v3/transfers/:id/"},"isReference":true,"order":1,"body":"This endpoint retrieves an existing transfer record if an `id` is provided. Otherwise, it will return a paginated list of transfers.\n\n## Properties\n\n* **id** - ID of the transfer record.\n* **account** - [Account](doc:crypto-accounts) ID of the user making the transfer.\n* **target_address** - The wallet address of the recipient.\n* **payment** - Specifies the outgoing payment ID of the transfer if the transfer was successful.\n* **exchange** - The exchange ID for non BTC->BTC transfers, such as BTC->PHP.\n* **status** - Specifies whether the transaction is `pending`, `success`, or `failed`.\n* **created_at** - Specifies the date when the transfer was created.","excerpt":"","slug":"transfers-3","type":"endpoint","title":"transfers"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string
Optional. ID of the transfer record to retrieve. If not provided, the endpoint will return the `transfers` history.

Query Params

reference__external_transaction_id:
string
A transaction ID provided by the API user. Usually, this transaction ID refers to a transaction in the API user's system.

Examples


Result Format


Documentation

This endpoint retrieves an existing transfer record if an `id` is provided. Otherwise, it will return a paginated list of transfers. ## Properties * **id** - ID of the transfer record. * **account** - [Account](doc:crypto-accounts) ID of the user making the transfer. * **target_address** - The wallet address of the recipient. * **payment** - Specifies the outgoing payment ID of the transfer if the transfer was successful. * **exchange** - The exchange ID for non BTC->BTC transfers, such as BTC->PHP. * **status** - Specifies whether the transaction is `pending`, `success`, or `failed`. * **created_at** - Specifies the date when the transfer was created.