/v2/reports/payments/create

POST

Returns a JSON structure with details of the payments 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
NameInTypeDescriptionFormat
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescriptionFormat
on_behalf_of formData string UUID of contact to act on behalf of.
description formData string Description that will be applied to report.
currency formData string 3 character ISO 4217 currency code.
amount_from formData string Amount of Payment to 2dp.
amount_to formData string Amount of Payment to 2dp.
status formData string Status of the payment.
payment_date_from formData string ISO 8601 Datetime when the payment should be paid. date
payment_date_to formData string ISO 8601 Datetime when the payment should be paid. date
transferred_at_from formData string ISO 8601 Datetime when the payment should be transfered. date
transferred_at_to formData string ISO 8601 Datetime when the payment should be transfered. date
created_at_from formData string ISO 8601 Datetime when the payment was created. date
created_at_to formData string ISO 8601 Datetime when the payment was created. date
updated_at_from formData string ISO 8601 Datetime when the payment was updated. date
updated_at_to formData string ISO 8601 Datetime when the payment was updated. date
beneficiary_id formData string ID of the beneficiary
conversion_id formData string Conversion unique ID
with_deleted formData string Allow to search within deleted payments too
payment_group_id formData string ID of the payment group
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/payments/create

Response

{
    "id": "88723dd2-f842-4e52-8b52-f11bb732b09e",
    "short_reference": "RP-3399488-CKBGZO",
    "description": null,
    "search_params": {
        "beneficiary_id": "6e5a40d3-b413-4b60-850b-c411f67735ce",
        "scope": "own"
    },
    "report_type": "payment",
    "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