/v2/reports/report_requests/{id}

GET

Returns a JSON structure with details of the specified report request.

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.
id path string ID of the report.
Optional
NameInTypeDescription
on_behalf_of query string UUID of contact to act on behalf of.
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/reports/report_requests/{id}

Response

{
    "id": "2d71d2de-bc17-4ffb-88f4-d644b327340f",
    "short_reference": "RP-1224584-ARBYRB",
    "description": null,
    "search_params": {
        "beneficiary_id": "7b300881-8d56-44d3-afd9-6a3dfc3c295d",
        "scope": "own"
    },
    "report_type": "payment",
    "status": "completed",
    "failure_reason": null,
    "expiration_date": "2018-08-12T00:00:00+00:00",
    "report_url": "https:\/\/ccycloud-reports-prod-demo1-customer-reporting.s3.eu-west-1.amazonaws.com\/customer_reporting\/2d71d2de-bc17-4ffb-88f4-d644b327340f\/payment_report_1008201815081533914796.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAWPXXYKBYLKTLJWLI%2F20181115%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20181115T140821Z&X-Amz-Expires=172800&X-Amz-SignedHeaders=host&X-Amz-Security-Token=FQoGZXIvYXdzEA8aDChASq85z1dp8HeW2CK3A%2BNo9y5m5ZxKYC7pOtWK0wC9SnWp6n4PA6Z%2FWT3%2BSk6Enp%2BedqRYTECS4Y5d0IuwMxloO2h4gwdeLvpDLbiFKEWC4wz1Ah4rHW5c9o8GAs5Nn3U%2FptyLvVh7wN%2FMD055ykUH6IfyvoyBTJzD8S3Ms%2BaIiUbr1U9ON7cco%2Fw3S56bfjf2WvXVIDzBvs9BsaAnENQ21M0Sj9Vc0nyQnjgQZM7c8JzbhV7l1sCe%2FbRr%2FnmAlxzgYL2BlaprEfbw5pOopRbsT9UxZWI5OB630X2PBe8fISjkDY7SA0gZS8T5BMjyMcVGn3M%2FdpY6x1pH4Bc921cmDsvdC4WINRmfBLvBgBc1CbzDk7R3ufgnohh1vhYF%2BzwUP7Uln7PpLP9ao4Yb7v%2B9LPbQHm4C10TklG%2BLSzCRathnU4qRFkj7PI09l%2BEBw4epaSTbrn5AU5xJHhEjL%2FmHepiVyh2C4dSeX%2B5h10TTNCevhd7SY7H6%2FnfYXGl3F28pjyhq3L6W1VS31fjE2z8otNt1jrYwBh451HuKrVOUeVb1RS9JTf6PvPKqfMbcjZ%2FqGYPuWll4AHAbe7lyLl8JIIBO0FQoxeu13wU%3D&X-Amz-Signature=dca1b2cb0668e99782710e125be2e90dc56f62db6c977f08564f35d61c5ea1a2",
    "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
    "contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
    "created_at": "2018-08-10T15:26:32+00:00",
    "updated_at": "2018-08-10T15:26:36+00:00"
}
Error Codes
HTTP Status Code Description Params
400 account_not_found Account 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