{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v3/transfers/:id/","auth":"required","apiSetting":"5d1d8bb82d46d1004a02581d","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)"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"transfers\": [\n        {\n            \"id\": \"2309rjw0amf0sq9me0gmadsmfoa\",\n            \"account\": \"90dfg03goamdf02fs\",\n            \"amount\": \"1\",\n            \"fee_amount\": \"0\",\n            \"gas_limit\": 0,\n            \"currency\": \"PBTC\",\n            \"target_address\": \"1374ba6c3b754\",\n            \"original_target_address\": \"example:::at:::example.com\",\n            \"original_target_address_type\": \"email\",\n            \"original_target_name\": \"Example\",\n            \"payment\": \"23094j0amd0fmag9agjgasd\",\n            \"exchange\": null,\n            \"status\": \"success\",\n            \"reference\": {},\n            \"message\": \"example\",\n            \"message_scope\": \"friends\",\n            \"priority\": \"low\",\n            \"created_at\": \"2019-07-04T03:28:50.531599Z\"\n        }\n    ],","name":""}]},"params":[{"name":"id","type":"string","default":"","desc":"Optional. ID of the transfer record to retrieve. If not provided, the endpoint will return the `transfers` history.","required":false,"in":"path","ref":"","_id":"5d1d9ab447822c013328b7f6"},{"name":"reference__external_transaction_id","type":"string","default":"","desc":"A transaction ID provided by the API user. Usually, this transaction ID refers to a transaction in the API user's system.","required":false,"in":"query","ref":"","_id":"5d1d9ab447822c013328b7f5"}],"method":"get","settings":"5d2c16e9ab606a0056359c3c"},"next":{"description":"","pages":[]},"title":"transfers","type":"endpoint","slug":"transfers-list","excerpt":"","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* **amount** - The amount being transferred. \n* **fee_amount** - The fee, if any, imposed on the transfer being made.\n* **currency** - The currency that is being transferred.\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* **message** - A note to the person you are transferring funds to.\n* **message_scope** - Determines who is able to see the message. If set to `private`, only the payer and payee can see the message. If set to `friends` only the payer and payee's friends on the app can see the message. If set to `public`, everyone can see the message.\n* **created_at** - Specifies the date when the transfer was created.","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d1d9ab447822c013328b7f4","version":{"version":"2.1","version_clean":"2.1.0","codename":"collector","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"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"],"_id":"56326e9cdf556c0d00cd08ca","project":"544fc17e698ab40800b4f891","releaseDate":"2015-10-29T19:08:12.724Z","__v":22,"createdAt":"2015-10-29T19:08:12.724Z"},"updatedAt":"2019-07-04T07:56:23.230Z","createdAt":"2019-07-04T06:20:36.183Z","project":"544fc17e698ab40800b4f891","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Wallets","slug":"wallets-1","order":21,"from_sync":false,"reference":true,"_id":"5d1d99810b2e4600500eb5ff","project":"544fc17e698ab40800b4f891","version":"56326e9cdf556c0d00cd08ca","isAPI":false,"createdAt":"2019-07-04T06:15:29.680Z","__v":0},"user":"5d19a189b4596f0072f571d4","__v":3,"parentDoc":null}

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. * **amount** - The amount being transferred. * **fee_amount** - The fee, if any, imposed on the transfer being made. * **currency** - The currency that is being transferred. * **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`. * **message** - A note to the person you are transferring funds to. * **message_scope** - Determines who is able to see the message. If set to `private`, only the payer and payee can see the message. If set to `friends` only the payer and payee's friends on the app can see the message. If set to `public`, everyone can see the message. * **created_at** - Specifies the date when the transfer was created.