/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
NameInTypeDescriptionEnumFormat
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescriptionEnumFormat
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": "786a5627-711f-4089-957f-51d7b4a1898a",
    "short_reference": "RP-2507408-POQQWR",
    "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-09-11T14:00:25+00:00",
    "updated_at": "2018-09-11T14:00:25+00:00"
}
Error Codes
HTTP Status Code Description Params
400 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