/v2/transfers/find

GET

Get transfer records based on search criteria.

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required
NameInTypeDescriptionEnumDefault
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescriptionEnumDefault
on_behalf_of query string Contact UUID.
short_reference query string Short reference code.
source_account_id query string Account UUID of the paying account.
destination_account_id query string Account UUID of the receiving account.
status query string Transfer status. completed
pending
currency query string Three-digit currency code.
amount_from query string Minimum amount.
amount_to query string Maximum amount.
created_at_from query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59Z".
created_at_to query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59Z".
updated_at_from query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59Z".
updated_at_to query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59Z".
completed_at_from query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59Z".
completed_at_to query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59Z".
creator_contact_id query string Contact UUID of transfer instructor.
creator_account_id query string Account UUID of transfer instructor.
page query integer Page number.
per_page query integer Number of results per page.
order query string Any field name to change the sort order. created_at
order_asc_desc query string Sort records in ascending or descending order. asc
desc
asc
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/transfers/find

Response

{
    "transfers": [
        {
            "id": "dbc1b2c3-fc83-439a-8ce9-5cdfc2cb321a",
            "short_reference": "BT-20180426-GKCRMN",
            "source_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "EUR",
            "amount": "1000.00",
            "status": "completed",
            "reason": "Transfer Test",
            "created_at": "2018-04-26T15:47:46+00:00",
            "updated_at": "2018-04-26T15:47:46+00:00",
            "completed_at": "2018-04-26T15:47:46+00:00",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "0594f892-7894-499d-9853-7cec86e27157",
            "short_reference": "BT-20180427-BHNWDG",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-04-27T10:49:35+00:00",
            "updated_at": "2018-04-27T10:49:35+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "adda16ef-a754-4b86-a3cd-0bf9de7673d0",
            "short_reference": "BT-20180427-CGRZWJ",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-04-27T10:56:00+00:00",
            "updated_at": "2018-04-27T10:56:00+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "7e33e240-83a9-435f-96f8-25fd61a3958f",
            "short_reference": "BT-20180427-RSBTZB",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-04-27T10:58:12+00:00",
            "updated_at": "2018-04-27T10:58:12+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "7ab98b99-3462-477b-8efc-aed6432fd1ce",
            "short_reference": "BT-20180427-XKTXKS",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-04-27T11:00:44+00:00",
            "updated_at": "2018-04-27T11:00:44+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "1ffec8fe-5341-4ad2-be8c-279e761161d3",
            "short_reference": "BT-20180427-FCFNPZ",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-04-27T13:04:52+00:00",
            "updated_at": "2018-04-27T13:04:52+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "78997366-d1ff-4539-b3e6-d4b88bb91347",
            "short_reference": "BT-20180427-LZKVTZ",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-04-27T13:57:52+00:00",
            "updated_at": "2018-04-27T13:57:52+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "8ba2db60-5fde-4f45-b845-4e126f33aa3f",
            "short_reference": "BT-20180427-JLQTJJ",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-04-27T14:16:22+00:00",
            "updated_at": "2018-04-27T14:16:22+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "3d981ec9-1a59-43b4-8e2f-d95be9818b05",
            "short_reference": "BT-20180427-RBJDWH",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-04-27T15:28:28+00:00",
            "updated_at": "2018-04-27T15:28:28+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "d81e9074-5c03-431e-991e-42ac66edc0e7",
            "short_reference": "BT-20180430-NVGVGW",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-04-30T11:34:18+00:00",
            "updated_at": "2018-04-30T11:34:18+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "2b0018a9-1cf8-4254-a2d1-0079b4e97522",
            "short_reference": "BT-20180430-KLHDMG",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-04-30T14:25:06+00:00",
            "updated_at": "2018-04-30T14:25:06+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "fbd0466d-c615-4f6b-a0d3-5c3b6811ce28",
            "short_reference": "BT-20180430-PXMFNF",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-04-30T15:01:50+00:00",
            "updated_at": "2018-04-30T15:01:50+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "b7e2c0f2-8463-4741-a772-9a48bc3f6a6a",
            "short_reference": "BT-20180501-JLVQZP",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-01T11:05:42+00:00",
            "updated_at": "2018-05-01T11:05:42+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "35cf8fa4-b17a-46a5-8e3f-989f0ae121e4",
            "short_reference": "BT-20180502-RHWVTB",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-02T09:02:28+00:00",
            "updated_at": "2018-05-02T09:02:28+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "0670f0db-3efe-4d8b-bd64-94b42d63f572",
            "short_reference": "BT-20180502-KCTGRP",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-02T09:13:52+00:00",
            "updated_at": "2018-05-02T09:13:52+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "47f15da0-ba31-4b2a-b4b3-85331181274d",
            "short_reference": "BT-20180502-QNLFFN",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-02T09:59:57+00:00",
            "updated_at": "2018-05-02T09:59:57+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "e3b4962c-3ae4-4a98-be94-2d4979544053",
            "short_reference": "BT-20180502-TWVKHR",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-02T14:14:16+00:00",
            "updated_at": "2018-05-02T14:14:16+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "8da02aa0-0aa9-4b71-9d68-16f055a130e2",
            "short_reference": "BT-20180503-LSCCWR",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-03T09:29:16+00:00",
            "updated_at": "2018-05-03T09:29:16+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "5fea9dab-f5c8-415c-921f-e8b91418e22f",
            "short_reference": "BT-20180504-PJWLLD",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-04T08:45:03+00:00",
            "updated_at": "2018-05-04T08:45:03+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "eed229d6-d09f-454a-9fc9-112686752a1f",
            "short_reference": "BT-20180504-HLFMXV",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-04T08:47:35+00:00",
            "updated_at": "2018-05-04T08:47:35+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "f9b30875-596a-40f9-bca9-8d26a1e6b3aa",
            "short_reference": "BT-20180509-BRTCLQ",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-09T09:49:51+00:00",
            "updated_at": "2018-05-09T09:49:51+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "7138af2b-cb66-4f60-92eb-2ebbcdd51762",
            "short_reference": "BT-20180510-WKTTFY",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-10T12:10:32+00:00",
            "updated_at": "2018-05-10T12:10:32+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "edcbda35-a28c-4f1e-8980-3567a523559f",
            "short_reference": "BT-20180514-PZBQLS",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-14T14:18:43+00:00",
            "updated_at": "2018-05-14T14:18:43+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "db809f0c-93f1-4b22-aa76-4a74ef51e046",
            "short_reference": "BT-20180516-PFYJYF",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-16T12:38:40+00:00",
            "updated_at": "2018-05-16T12:38:40+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        },
        {
            "id": "fecd7ca9-8f7d-4603-8ac4-3fa6d08e434d",
            "short_reference": "BT-20180516-TSNVCN",
            "source_account_id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
            "destination_account_id": "22ed17b5-b90c-424e-aa78-d24928b1778e",
            "currency": "GBP",
            "amount": "100.00",
            "status": "pending",
            "reason": "",
            "created_at": "2018-05-16T12:40:51+00:00",
            "updated_at": "2018-05-16T12:40:51+00:00",
            "completed_at": "",
            "creator_account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781"
        }
    ],
    "pagination": {
        "total_entries": 278,
        "total_pages": 12,
        "current_page": 1,
        "per_page": 25,
        "previous_page": -1,
        "next_page": 2,
        "order": "created_at",
        "order_asc_desc": "asc"
    }
}
Error Codes
HTTP Status Code Description Params
400 source_account_id_is_not_valid_uuid source_account_id should be in UUID format
destination_account_id_is_not_valid_uuid destination_account_id should be in UUID format
amount_from_type_is_wrong amount_from should be of numeric type { "type" => "numeric" }
amount_to_type_is_wrong amount_to should be of numeric type { "type" => "numeric" }
status_not_in_range status should be in range: pending, completed { "range" => "pending, completed" }
created_at_from_is_in_invalid_format created_at_from should be in ISO 8601 format { "type" => "datetime" }
created_at_to_is_in_invalid_format created_at_to should be in ISO 8601 format { "type" => "datetime" }
updated_at_from_is_in_invalid_format updated_at_from should be in ISO 8601 format { "type" => "datetime" }
updated_at_to_is_in_invalid_format updated_at_to should be in ISO 8601 format { "type" => "datetime" }
completed_at_from_is_in_invalid_format completed_at_from should be in ISO 8601 format { "type" => "datetime" }
completed_at_to_is_in_invalid_format completed_at_to should be in ISO 8601 format { "type" => "datetime" }
creator_contact_id_is_not_valid_uuid creator_contact_id should be in UUID format
creator_account_id_is_not_valid_uuid creator_account_id should be in UUID format
on_behalf_of_self You cannot act on behalf of your own Contact
contact_not_found Contact was not found for this id
401 invalid_supplied_credentials Authentication failed with the supplied credentials
429 too_many_requests Too many requests have been made to the api. Please refer to the Developer Center for more information
500 internal_server_error Internal server error
503 service_unavailable Service is temporary unavailable
Was this page helpful?
Yes
No