/v2/payments/find

GET

Search for payment records.

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
NameInTypeDescriptionEnumFormatDefault
X-Auth-Token header string Authentication token.
Optional
NameInTypeDescriptionEnumFormatDefault
on_behalf_of query string Contact UUID.
short_reference query string Short reference code.
currency query string Currency in which payment made. Three-digit currency code.
amount query string Exact amount.
amount_from query string Minimum amount.
amount_to query string Maximum amount.
status query string Payment status. new
completed
failed
released
suspended
awaiting_authorisation
submitted
authorised
reason query string User-generated reason for payment. Freeform text.
payment_date_from query string Earliest instructed payment date. Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00". date
payment_date_to query string Latest instructed payment date. Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00". date
transferred_at_from query string Earliest date of payment processing. Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00". date-time
transferred_at_to query string Latest date of payment processing. Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00". date-time
created_at_from query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00". date-time
created_at_to query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00". date-time
updated_at_from query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00". date-time
updated_at_to query string Any valid ISO 8601 format, eg. "2017-12-31T23:59:59+00:00". date-time
beneficiary_id query string Beneficiary UUID.
conversion_id query string Conversion UUID.
with_deleted query boolean Include deleted payments.
payment_group_id query string Payment group.
unique_request_id query string User-generated idempotency key.
scope query string "Own" account, "clients" sub-accounts, or "all" accounts. all
own
clients
own
bulk_upload_id query string Bulk upload reference code.
page query integer Page number.
per_page query integer Number of results per page.
order query string Any field name to change the sort order.
order_asc_desc query string Sort records in ascending or descending order. asc
desc
asc
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/payments/find

Response

{
    "payments": [
        {
            "id": "ee83aaf4-dc51-41e6-af15-857f210b4501",
            "amount": "10.00",
            "beneficiary_id": "59ad88f3-72c5-4711-a158-552bfb8f3bb9",
            "currency": "GBP",
            "reference": "This is a test reference.",
            "reason": "This is a test payment.",
            "status": "ready_to_send",
            "creator_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "payment_type": "regular",
            "payment_date": "2018-08-13",
            "transferred_at": "",
            "authorisation_steps_required": "0",
            "last_updater_contact_id": "a66ca63f-e668-47af-8bb9-74363240d781",
            "short_reference": "180810-ZVPVXH001",
            "conversion_id": null,
            "failure_reason": "",
            "payer_id": "68561f01-b5d8-4fad-9bcb-d1712a1bc0c8",
            "payer_details_source": "account",
            "created_at": "2018-08-10T18:15:55+00:00",
            "updated_at": "2018-08-10T18:15:55+00:00",
            "payment_group_id": null,
            "unique_request_id": null,
            "failure_returned_amount": "0.00",
            "ultimate_beneficiary_name": null
        }
    ],
    "pagination": {
        "total_entries": 1,
        "total_pages": 1,
        "current_page": 1,
        "per_page": 25,
        "previous_page": -1,
        "next_page": -1,
        "order": "created_at",
        "order_asc_desc": "asc"
    }
}
Error Codes
HTTP Status Code Description Params
400 invalid_currency currency has invalid format
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