/v2/conversions/profit_and_loss

GET

Returns a JSON structure that contains information related to actions on conversions that have generated profit or loss, including the profit or loss amount

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
NameInTypeDescription
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescription
account_id formData string ID of the Account that the Conversion belongs to.
contact_id formData string ID of the Contact that did the cancellation.
conversion_id formData string ID of the cancelled conversion.
event_type formData string Event type, in this case 'self_service_cancellation'
event_date_time_from formData string Allows you to return profit and losses will be done from on or after a defined date/time. ISO 8601 standard.
event_date_time_to formData string Allows you to return profit and losses will be done from on or before a defined date/time. ISO 8601 standard.
amount_from formData string Allows you to return profit and losses based on a minimum profit or loss amount.
amount_to formData string Allows you to return profit and losses based on a maximum profit or loss amount.
currency formData string The currency of the profit and loss. ISO 4217 standard.
scope formData string Scope allows contacts to search all profit and losses at all account levels. Defaults to own. own - allows to search profit and losses on the main account clients - allows to search profit and losses of account sub accounts all - allows to search balances profit and losses account and subaccounts
page formData string Returns a specific page within the results of a search.
per_page formData string Maximum number of entries to return per page of results.
order formData string The field to order entries by.
order_asc_desc formData string Whether the order is ascending (asc) or descending (desc). 
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/conversions/profit_and_loss

Response

{
    "conversion_profit_and_losses": [
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "515eaa18-0756-42b9-9899-49bfea5d3e8a",
            "event_type": "self_service_cancellation",
            "amount": "-0.01",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-19T15:55:15+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "10c79aba-a9ee-41c2-b0ce-89a0941a8599",
            "event_type": "self_service_cancellation",
            "amount": "-0.01",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-19T16:20:45+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "bb95fa2e-52f7-4219-8710-110e60e1ed91",
            "event_type": "self_service_cancellation",
            "amount": "-0.01",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-19T16:29:32+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "a0c4b690-02dc-4c3d-9fbf-04b9aa90d22e",
            "event_type": "self_service_cancellation",
            "amount": "-0.01",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-19T16:35:00+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "80d6be02-4a54-4a43-a354-0555a453c470",
            "event_type": "self_service_cancellation",
            "amount": "-0.01",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-19T16:40:59+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "c94ff02e-26a3-48d1-863c-80b0d848ab22",
            "event_type": "self_service_roll",
            "amount": "0.29",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-19T16:46:09+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "c94ff02e-26a3-48d1-863c-80b0d848ab22",
            "event_type": "self_service_cancellation",
            "amount": "-0.32",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-19T16:46:14+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "337d1c8e-b947-422c-bc44-04570841f8d2",
            "event_type": "self_service_roll",
            "amount": "0.29",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-19T16:49:18+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "337d1c8e-b947-422c-bc44-04570841f8d2",
            "event_type": "self_service_cancellation",
            "amount": "-0.32",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-19T16:49:21+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "133d678a-dfcc-46b6-aec4-9ac14909ad86",
            "event_type": "self_service_roll",
            "amount": "0.29",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-19T16:52:51+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "133d678a-dfcc-46b6-aec4-9ac14909ad86",
            "event_type": "self_service_cancellation",
            "amount": "-0.32",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-19T16:53:11+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "a0a0117a-14c0-489e-9567-8e460de45fd2",
            "event_type": "self_service_roll",
            "amount": "0.14",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-21T09:11:53+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "a0a0117a-14c0-489e-9567-8e460de45fd2",
            "event_type": "self_service_cancellation",
            "amount": "-0.17",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-21T09:12:10+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "de7849c3-11af-4298-9894-0760d45c6b57",
            "event_type": "self_service_roll",
            "amount": "0.14",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-21T10:11:49+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "de7849c3-11af-4298-9894-0760d45c6b57",
            "event_type": "self_service_cancellation",
            "amount": "-0.11",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-21T10:12:09+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "b3313688-e8e1-4307-8e5c-7e09a4189281",
            "event_type": "self_service_roll",
            "amount": "0.14",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-21T10:17:10+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "b3313688-e8e1-4307-8e5c-7e09a4189281",
            "event_type": "self_service_cancellation",
            "amount": "-0.11",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-21T10:18:13+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "7c6df92e-56c4-4dc9-97bf-d2c35c7573f7",
            "event_type": "self_service_roll",
            "amount": "0.14",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-22T11:03:22+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "7c6df92e-56c4-4dc9-97bf-d2c35c7573f7",
            "event_type": "self_service_cancellation",
            "amount": "-0.11",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-22T11:04:25+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "fb43335d-1886-4046-947e-14c4613f8cca",
            "event_type": "self_service_roll",
            "amount": "0.14",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-22T11:33:23+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "fb43335d-1886-4046-947e-14c4613f8cca",
            "event_type": "self_service_cancellation",
            "amount": "-0.11",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-22T11:34:26+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "8187af20-ee2d-40b4-bfe2-a8c4314a99dc",
            "event_type": "self_service_roll",
            "amount": "0.14",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-22T11:38:40+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "8187af20-ee2d-40b4-bfe2-a8c4314a99dc",
            "event_type": "self_service_cancellation",
            "amount": "-0.11",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-22T11:39:43+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "7e01ffc1-2260-4194-ad9f-33f03182cc05",
            "event_type": "self_service_roll",
            "amount": "0.14",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-22T11:55:28+00:00"
        },
        {
            "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
            "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "event_account_id": null,
            "event_contact_id": null,
            "conversion_id": "7e01ffc1-2260-4194-ad9f-33f03182cc05",
            "event_type": "self_service_cancellation",
            "amount": "-0.11",
            "currency": "GBP",
            "notes": "",
            "event_date_time": "2018-06-22T11:56:31+00:00"
        }
    ],
    "pagination": {
        "total_entries": 444,
        "total_pages": 18,
        "current_page": 1,
        "per_page": 25,
        "previous_page": -1,
        "next_page": 2,
        "order": "event_date_time",
        "order_asc_desc": "asc"
    }
}
Error Codes
HTTP Status Code Description Params
400 id_is_not_valid_uuid 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
invalid_extra_parameters Invalid extra parameters extra_parameter { "parameters" => "extra_parameter" }
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

Start your borderless payments journey today

Talk to an expert

Cookies

This site uses cookies: Read our cookie policy