{"_id":"56326e9fdf556c0d00cd08e1","category":{"_id":"56326e9ddf556c0d00cd08d2","project":"544fc17e698ab40800b4f891","version":"56326e9cdf556c0d00cd08ca","pages":["56326e9fdf556c0d00cd08e0","56326e9fdf556c0d00cd08e1","56326e9fdf556c0d00cd08e2","56326e9fdf556c0d00cd08e3","56326e9fdf556c0d00cd08e4","56326e9fdf556c0d00cd08e5","56326e9fdf556c0d00cd08e6","56326e9fdf556c0d00cd08e7","56326e9fdf556c0d00cd08e8"],"__v":1,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-01T08:07:30.539Z","from_sync":false,"order":8,"slug":"wallets","title":"Wallets"},"project":"544fc17e698ab40800b4f891","user":"544fc065698ab40800b4f888","editedParams2":true,"__v":3,"editedParams":true,"parentDoc":null,"version":{"_id":"56326e9cdf556c0d00cd08ca","project":"544fc17e698ab40800b4f891","__v":2,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"collector","version_clean":"2.1.0","version":"2.1"},"updates":["55ca002b5818be2100d76347","59a7189e757d030019b85701","59c797da2e6e2f0010caba4c"],"next":{"pages":[],"description":""},"createdAt":"2015-05-22T03:25:15.893Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"python","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)","name":""}]},"method":"get","results":{"codes":[{"status":200,"language":"json","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}","name":""}]},"settings":"","auth":"required","params":[{"_id":"555ea19b57fe0a0d00c8f311","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":"57d90c3c5a2c4e0e00c3059e","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":false,"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-1","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.