Generate Conversion Report - Currencycloud API Documentation

Home > Manage > Reporting > Generate Conversion Report

/v2/reports/conversions/create

POST

Returns a JSON structure with details of the conversion report requested.

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

Name	In	Type	Description	Enum	Format
X-Auth-Token	header	string	Authentication token.
Optional
Name	In	Type	Description	Enum	Format
on_behalf_of	formData	string	UUID of contact to act on behalf of.
description	formData	string	Description that will be applied to report.
buy_currency	formData	string	3 character ISO 4217 currency code.
sell_currency	formData	string	3 character ISO 4217 currency code.
client_buy_amount_from	formData	string	.
client_buy_amount_to	formData	string	.
client_sell_amount_from	formData	string	.
client_sell_amount_to	formData	string	.
partner_buy_amount_from	formData	string	Minimum buy amount (sub-accounts).
partner_buy_amount_to	formData	string	Maximum buy amount (sub-accounts).
partner_sell_amount_from	formData	string	Minimum sell amount (sub-accounts).
partner_sell_amount_to	formData	string	Maximum sell amount (sub-accounts).
client_status	formData	string	The current status of the Conversion - awaiting_funds - funds_sent - funds_arrived - trade_settled - closed.	awaiting_funds funds_sent funds_arrived trade_settled closed
partner_status	formData	string	The current status of the Conversion - awaiting_funds - funds_sent - funds_arrived - trade_settled - closed.	awaiting_funds funds_sent funds_arrived trade_settled closed
conversion_date_from	formData	string	ISO 8601 Datetime when buy currency was delivered.		date
conversion_date_to	formData	string	ISO 8601 Datetime when buy currency was delivered.		date
settlement_date_from	formData	string	ISO 8601 Datetime when the sell_currency was debited.		date
settlement_date_to	formData	string	ISO 8601 Datetime when the sell_currency was debited.		date
created_at_from	formData	string	ISO 8601 Datetime when the conversion was created.		date
created_at_to	formData	string	ISO 8601 Datetime when the conversion was created.		date
updated_at_from	formData	string	ISO 8601 Datetime when the conversion was updated.		date
updated_at_to	formData	string	ISO 8601 Datetime when the conversion was updated.		date
unique_request_id	formData	string	Unique request ID of conversion
scope	formData	string	Specify which account level will be used; 'own' is a default value.

curl -X POST  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/reports/conversions/create

Response

{
    "id": "00836ab0-0a52-4c5a-88a9-54d4e07c92cf",
    "short_reference": "RP-8031172-YUZBPY",
    "description": null,
    "search_params": {
        "scope": "own"
    },
    "report_type": "conversion",
    "status": "processing",
    "failure_reason": null,
    "expiration_date": null,
    "report_url": "",
    "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
    "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
    "created_at": "2018-12-14T11:37:21+00:00",
    "updated_at": "2018-12-14T11:37:21+00:00"
}

Error Codes

HTTP Status	Code	Description
400	on_behalf_of_self	You cannot act on behalf of your own Contact
400	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

/v2/reports/conversions/create

POST

API parameters

Required

Optional

Response

Error Codes

Start your borderless payments journey today

Cookies