/v2/transactions/find

GET

Search for transactions.

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
NameInTypeDescriptionEnumFormatDefault
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescriptionEnumFormatDefault
on_behalf_of query string Contact UUID.
currency query string Three-digit currency code.
amount query integer Amount.
amount_from query integer Minimum amount.
amount_to query integer Maximum amount.
action query string The action that triggered the transaction. funding
conversion
payment
payment_failure
manual_intervention
manual_transaction
related_entity_type query string The related entity that created the transaction. conversion
payment
inbound_funds
related_entity_id query string UUID of the related entity.
related_entity_short_reference query string Short reference code.
status query string Transaction status. completed
pending
deleted
type query string Whether the transaction debits or credits the account balance. debit
credit
reason query string User-generated reason for payment. Freeform text.
settles_at_from query string Earliest processing date. Any valid ISO 8601 format, eg. "2017-12-31". date
settles_at_to query string Latest processing date. Any valid ISO 8601 format, eg. "2017-12-31". date
created_at_from query string Any valid ISO 8601 format, eg. "2017-12-31". date
created_at_to query string Any valid ISO 8601 format, eg. "2017-12-31". date
updated_at_from query string Any valid ISO 8601 format, eg. "2017-12-31". date
updated_at_to query string Any valid ISO 8601 format, eg. "2017-12-31". date
completed_at_from query string Any valid ISO 8601 format, eg. "2017-12-31". date
completed_at_to query string Any valid ISO 8601 format, eg. "2017-12-31". date
beneficiary_id query string Beneficiary UUID. Required if "related_entity_type" is "payment".
currency_pair query string Concatenated string of the two currencies traded, eg. "USDEUR". Required if "related_entity_type" is "conversion".
scope query string "Own" account, "clients" sub-accounts, or "all" accounts. all
own
clients
own
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/transactions/find

Response

{
    "transactions": [
        {
            "id": "85280ea5-ba77-414b-af1f-18283d4f140c",
            "balance_id": "209ca23c-6ac3-442f-a666-aacd98b33c8b",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "USD",
            "amount": "100000.00",
            "balance_amount": "100000.00",
            "type": "credit",
            "related_entity_type": "inbound_funds",
            "related_entity_id": "85ab4e71-5a94-48eb-8ce6-9b829e102195",
            "related_entity_short_reference": "",
            "status": "completed",
            "reason": "",
            "settles_at": "2018-04-18T12:30:39+00:00",
            "created_at": "2018-04-18T12:30:39+00:00",
            "updated_at": "2018-04-18T12:30:39+00:00",
            "completed_at": "2018-04-18T12:30:39+00:00",
            "action": "funding"
        },
        {
            "id": "1d6b5786-b080-4571-87c3-5b053e519387",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "100000.00",
            "balance_amount": "100000.00",
            "type": "credit",
            "related_entity_type": "inbound_funds",
            "related_entity_id": "ac8a3f56-a001-4107-9011-7204650c51db",
            "related_entity_short_reference": "",
            "status": "completed",
            "reason": "",
            "settles_at": "2018-04-18T12:30:40+00:00",
            "created_at": "2018-04-18T12:30:40+00:00",
            "updated_at": "2018-04-18T12:30:40+00:00",
            "completed_at": "2018-04-18T12:30:40+00:00",
            "action": "funding"
        },
        {
            "id": "70a479eb-a301-43d0-a241-5a9652e24079",
            "balance_id": "3ef765f6-0a91-4deb-8077-dbfd869987e6",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "EUR",
            "amount": "100000.00",
            "balance_amount": "100000.00",
            "type": "credit",
            "related_entity_type": "inbound_funds",
            "related_entity_id": "e7765777-f23d-4d82-8ad1-b27e0329ca27",
            "related_entity_short_reference": "",
            "status": "completed",
            "reason": "",
            "settles_at": "2018-04-18T12:30:41+00:00",
            "created_at": "2018-04-18T12:30:41+00:00",
            "updated_at": "2018-04-18T12:30:41+00:00",
            "completed_at": "2018-04-18T12:30:41+00:00",
            "action": "funding"
        },
        {
            "id": "a153c3dc-b8ef-46a4-80dc-4f45c24ab98c",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "70.93",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "conversion",
            "related_entity_id": "7b8a99d4-8cca-4e3a-aee1-65cf9e7eab21",
            "related_entity_short_reference": "20180426-JZVBHW",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T15:05:13+00:00",
            "updated_at": "2018-06-25T09:38:38+00:00",
            "completed_at": "",
            "action": "conversion"
        },
        {
            "id": "ed7463be-29cc-4a50-a16b-c5dc9d264800",
            "balance_id": "209ca23c-6ac3-442f-a666-aacd98b33c8b",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "USD",
            "amount": "100.00",
            "balance_amount": null,
            "type": "credit",
            "related_entity_type": "conversion",
            "related_entity_id": "7b8a99d4-8cca-4e3a-aee1-65cf9e7eab21",
            "related_entity_short_reference": "20180426-JZVBHW",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T15:05:13+00:00",
            "updated_at": "2018-06-25T09:38:38+00:00",
            "completed_at": "",
            "action": "conversion"
        },
        {
            "id": "c9895c74-a5cf-4c31-ad5e-c7b57e522d0d",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "10.00",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "payment",
            "related_entity_id": "de6fd724-f536-477e-9bcd-39a9b8e71178",
            "related_entity_short_reference": "180426-MMCXYK001",
            "status": "deleted",
            "reason": "",
            "settles_at": "2018-04-26T00:00:00+00:00",
            "created_at": "2018-04-26T15:05:17+00:00",
            "updated_at": "2018-04-26T15:05:17+00:00",
            "completed_at": "",
            "action": "payment"
        },
        {
            "id": "77a70dd1-ce91-4164-ad33-053de6812c3f",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "1000.00",
            "balance_amount": "99000.00",
            "type": "debit",
            "related_entity_type": "payment",
            "related_entity_id": "28b381a2-6466-4ee9-a56a-ff2d7efba25d",
            "related_entity_short_reference": "180426-DWKXZX001",
            "status": "completed",
            "reason": "",
            "settles_at": "2018-04-26T00:00:00+00:00",
            "created_at": "2018-04-26T15:39:41+00:00",
            "updated_at": "2018-04-26T15:45:02+00:00",
            "completed_at": "2018-04-26T15:45:02+00:00",
            "action": "payment"
        },
        {
            "id": "1d51b1a3-af3d-41e6-89f4-74f600a1cf37",
            "balance_id": "3ef765f6-0a91-4deb-8077-dbfd869987e6",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "EUR",
            "amount": "1000.00",
            "balance_amount": "99000.00",
            "type": "debit",
            "related_entity_type": "balance_transfer",
            "related_entity_id": "dbc1b2c3-fc83-439a-8ce9-5cdfc2cb321a",
            "related_entity_short_reference": "BT-20180426-GKCRMN",
            "status": "completed",
            "reason": "Transfer Test",
            "settles_at": "2018-04-26T15:47:46+00:00",
            "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",
            "action": "transfer"
        },
        {
            "id": "2a0349ee-1b67-4f59-8e94-89483518ac96",
            "balance_id": "209ca23c-6ac3-442f-a666-aacd98b33c8b",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "USD",
            "amount": "150.00",
            "balance_amount": null,
            "type": "credit",
            "related_entity_type": "conversion",
            "related_entity_id": "d8d48ff3-0a88-425f-a136-dda00614a6fc",
            "related_entity_short_reference": "20180426-FBYXZM",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T18:29:06+00:00",
            "updated_at": "2018-04-26T18:29:06+00:00",
            "completed_at": "",
            "action": "conversion"
        },
        {
            "id": "ba4b80fd-6982-4916-8da8-d268364f5950",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "106.39",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "conversion",
            "related_entity_id": "d8d48ff3-0a88-425f-a136-dda00614a6fc",
            "related_entity_short_reference": "20180426-FBYXZM",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T18:29:06+00:00",
            "updated_at": "2018-04-26T18:29:06+00:00",
            "completed_at": "",
            "action": "conversion"
        },
        {
            "id": "a4e3b64b-749f-4f43-90f0-a085e3e99dfb",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "10.00",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "payment",
            "related_entity_id": "7448e39c-1800-4ab3-b318-3ed3ef4cacad",
            "related_entity_short_reference": "180426-GWJLMB001",
            "status": "deleted",
            "reason": "",
            "settles_at": "2018-04-27T00:00:00+00:00",
            "created_at": "2018-04-26T18:29:09+00:00",
            "updated_at": "2018-04-26T18:29:10+00:00",
            "completed_at": "",
            "action": "payment"
        },
        {
            "id": "073f0c55-0ebd-4bba-8dd0-b711fa8cce1b",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "106.39",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "conversion",
            "related_entity_id": "2e4404d4-2a09-4531-819f-4deb0b44a944",
            "related_entity_short_reference": "20180426-YPBTTK",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T18:47:18+00:00",
            "updated_at": "2018-04-26T18:47:18+00:00",
            "completed_at": "",
            "action": "conversion"
        },
        {
            "id": "85353a41-1e76-418a-905f-a5ab55b9935e",
            "balance_id": "209ca23c-6ac3-442f-a666-aacd98b33c8b",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "USD",
            "amount": "150.00",
            "balance_amount": null,
            "type": "credit",
            "related_entity_type": "conversion",
            "related_entity_id": "2e4404d4-2a09-4531-819f-4deb0b44a944",
            "related_entity_short_reference": "20180426-YPBTTK",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T18:47:18+00:00",
            "updated_at": "2018-04-26T18:47:18+00:00",
            "completed_at": "",
            "action": "conversion"
        },
        {
            "id": "815fb844-50e8-40e2-ac8e-6c2dabf99016",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "10.00",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "payment",
            "related_entity_id": "623dc8b1-856c-4708-bfa7-dac773da41c8",
            "related_entity_short_reference": "180426-PLSBSW001",
            "status": "deleted",
            "reason": "",
            "settles_at": "2018-04-27T00:00:00+00:00",
            "created_at": "2018-04-26T18:47:21+00:00",
            "updated_at": "2018-04-26T18:47:21+00:00",
            "completed_at": "",
            "action": "payment"
        },
        {
            "id": "c8769e81-602a-429d-8c46-36c765108342",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "10.00",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "payment",
            "related_entity_id": "dc2c502b-8509-49d5-8cc2-5654f6c1d1b8",
            "related_entity_short_reference": "180426-JFHRCP001",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-27T00:00:00+00:00",
            "created_at": "2018-04-26T18:47:22+00:00",
            "updated_at": "2018-04-26T18:47:22+00:00",
            "completed_at": "",
            "action": "payment"
        },
        {
            "id": "5083e96b-c31c-49d5-9b97-cb365b0ff723",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "106.39",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "conversion",
            "related_entity_id": "d893ad5d-ce24-4c4f-bfdb-9f261fe78f9c",
            "related_entity_short_reference": "20180426-RHYZMF",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T18:50:22+00:00",
            "updated_at": "2018-04-26T18:50:22+00:00",
            "completed_at": "",
            "action": "conversion"
        },
        {
            "id": "a15d8b39-f3fb-4641-a39d-2910e08f6c9a",
            "balance_id": "209ca23c-6ac3-442f-a666-aacd98b33c8b",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "USD",
            "amount": "150.00",
            "balance_amount": null,
            "type": "credit",
            "related_entity_type": "conversion",
            "related_entity_id": "d893ad5d-ce24-4c4f-bfdb-9f261fe78f9c",
            "related_entity_short_reference": "20180426-RHYZMF",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T18:50:22+00:00",
            "updated_at": "2018-04-26T18:50:22+00:00",
            "completed_at": "",
            "action": "conversion"
        },
        {
            "id": "9457897f-df43-4735-9761-26132ada6fe8",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "10.00",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "payment",
            "related_entity_id": "c9938bd4-d232-4ad6-939f-371e7c4a87b2",
            "related_entity_short_reference": "180426-QJFRFV001",
            "status": "deleted",
            "reason": "",
            "settles_at": "2018-04-27T00:00:00+00:00",
            "created_at": "2018-04-26T18:50:25+00:00",
            "updated_at": "2018-04-26T18:50:25+00:00",
            "completed_at": "",
            "action": "payment"
        },
        {
            "id": "c3cdeaf0-c944-450b-99cd-26d3e9f58dda",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "10.00",
            "balance_amount": "98980.00",
            "type": "debit",
            "related_entity_type": "payment",
            "related_entity_id": "42cb2887-31a5-42b5-afc3-8ff6c85e38be",
            "related_entity_short_reference": "180426-FVLSJT001",
            "status": "completed",
            "reason": "",
            "settles_at": "2018-04-27T00:00:00+00:00",
            "created_at": "2018-04-26T18:50:26+00:00",
            "updated_at": "2018-04-27T00:00:01+00:00",
            "completed_at": "2018-04-27T00:00:01+00:00",
            "action": "payment"
        },
        {
            "id": "c9a8e1f8-9b3e-4e32-983b-d9688be0323c",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "106.39",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "conversion",
            "related_entity_id": "67ad6a0f-7da0-43cc-a540-aa70343186c7",
            "related_entity_short_reference": "20180426-VMQGJJ",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T19:01:26+00:00",
            "updated_at": "2018-04-26T19:01:26+00:00",
            "completed_at": "",
            "action": "conversion"
        },
        {
            "id": "ef376867-5e2e-4aa4-89f3-9fc76a33c3f4",
            "balance_id": "209ca23c-6ac3-442f-a666-aacd98b33c8b",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "USD",
            "amount": "150.00",
            "balance_amount": null,
            "type": "credit",
            "related_entity_type": "conversion",
            "related_entity_id": "67ad6a0f-7da0-43cc-a540-aa70343186c7",
            "related_entity_short_reference": "20180426-VMQGJJ",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T19:01:26+00:00",
            "updated_at": "2018-04-26T19:01:26+00:00",
            "completed_at": "",
            "action": "conversion"
        },
        {
            "id": "52568875-84b5-4182-93f8-591bb0650add",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "10.00",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "payment",
            "related_entity_id": "8d1dc315-8069-4580-abbd-8c9806e5b799",
            "related_entity_short_reference": "180426-LQNJGF001",
            "status": "deleted",
            "reason": "",
            "settles_at": "2018-04-27T00:00:00+00:00",
            "created_at": "2018-04-26T19:01:27+00:00",
            "updated_at": "2018-04-26T19:01:29+00:00",
            "completed_at": "",
            "action": "payment"
        },
        {
            "id": "4f0ea2fd-13b0-4ecf-981b-862b47cd49d5",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "10.00",
            "balance_amount": "98970.00",
            "type": "debit",
            "related_entity_type": "payment",
            "related_entity_id": "df9c0620-5e88-487a-8b04-c434734e4dbb",
            "related_entity_short_reference": "180426-KVMGZB001",
            "status": "completed",
            "reason": "",
            "settles_at": "2018-04-27T00:00:00+00:00",
            "created_at": "2018-04-26T19:01:30+00:00",
            "updated_at": "2018-04-27T00:00:04+00:00",
            "completed_at": "2018-04-27T00:00:04+00:00",
            "action": "payment"
        },
        {
            "id": "33c389fd-3221-4399-8b2c-55bcde4d01e9",
            "balance_id": "4e33f858-7f51-477d-9a15-aaa852f2a59e",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "GBP",
            "amount": "106.39",
            "balance_amount": null,
            "type": "debit",
            "related_entity_type": "conversion",
            "related_entity_id": "bdc6406a-3c06-4162-8a8d-6aed8885a32d",
            "related_entity_short_reference": "20180426-BRTNMS",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T19:11:03+00:00",
            "updated_at": "2018-04-26T19:11:03+00:00",
            "completed_at": "",
            "action": "conversion"
        },
        {
            "id": "61b1eaa0-d812-41b0-9ee5-bb3facac2575",
            "balance_id": "209ca23c-6ac3-442f-a666-aacd98b33c8b",
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "currency": "USD",
            "amount": "150.00",
            "balance_amount": null,
            "type": "credit",
            "related_entity_type": "conversion",
            "related_entity_id": "bdc6406a-3c06-4162-8a8d-6aed8885a32d",
            "related_entity_short_reference": "20180426-BRTNMS",
            "status": "pending",
            "reason": "",
            "settles_at": "2018-04-30T15:30:00+00:00",
            "created_at": "2018-04-26T19:11:03+00:00",
            "updated_at": "2018-04-26T19:11:03+00:00",
            "completed_at": "",
            "action": "conversion"
        }
    ],
    "pagination": {
        "total_entries": 1937,
        "total_pages": 78,
        "current_page": 1,
        "per_page": 25,
        "previous_page": -1,
        "next_page": 2,
        "order": "default",
        "order_asc_desc": "asc"
    }
}
Error Codes
HTTP Status Code Description Params
400 transaction_not_found No Transaction found for 21b552e0-d97c-612d-2335-34203ab3f267
contact_not_found Contact was not found for this id
on_behalf_of_self You cannot act on behalf of your own Contact
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