{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml","api-docs-apis/openapi.yaml":"api-docs-apis/openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["replay-openapi"]},"type":"markdown"},"seo":{"title":"Reefpay Docs","description":"Reefpay is the groundbreaking payment gateway that lets you integrate with the future of payments."},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"client-reports","__idx":0},"children":["Client reports"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Five read endpoints cover the account side. They answer two questions: who is in"," ","my portfolio, and is each one wired up correctly."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Answers"},"children":["Answers"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/clients"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Which clients do I own"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/clients/{clientId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["What does this one look like"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/integrations"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Which integrations exist"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/integrations/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["What is this integration's full configuration"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/integrations/summary/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Is this client wired up, briefly"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A reseller sees its own subtree. A merchant sees only itself."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"list-your-clients","__idx":1},"children":["List your clients"]},{"$$mdtype":"Tag","name":"ReplayOpenApi","attributes":{"descriptionFile":"api-docs-apis/openapi.yaml","operationId":"listClients","parameters":{},"options":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The query parameters here are PascalCase."]}," This endpoint is the exception in"," ","an otherwise snake_case API, and it has not been reconciled:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Does"},"children":["Does"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Take"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page size"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Skip"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Records to skip"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SortColumn"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Column to sort on"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SortOrder"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ASC"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DESC"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SearchText"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Free-text search"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Term"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional filter term"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sending ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["take"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skip"]}," in lower case does not work. Compare"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/after-the-payment/find-and-report-on-transactions"},"children":["the transaction endpoints"]},","," ","which use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offset"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/batches"]},", which uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skip"]}," and"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["take"]}," in lower case. Three endpoints, three conventions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retrieve-one-client","__idx":2},"children":["Retrieve one client"]},{"$$mdtype":"Tag","name":"ReplayOpenApi","attributes":{"descriptionFile":"api-docs-apis/openapi.yaml","operationId":"getClient","parameters":{},"options":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns the client's DBA, type, addresses, contact details, and metadata."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["It does not return the API key."]}," Nothing does, after the create response. If a"," ","merchant has lost its key, the key has to be reissued rather than looked up."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"check-a-clients-integrations","__idx":3},"children":["Check a client's integrations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The summary endpoint is the quick one — it answers \"is this client able to"," ","process, and on which rails\"."]},{"$$mdtype":"Tag","name":"ReplayOpenApi","attributes":{"descriptionFile":"api-docs-apis/openapi.yaml","operationId":"listIntegrationSummary","parameters":{},"options":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each entry carries ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["processor"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_active"]}," and nothing else. That is"," ","usually all a portfolio view needs, and it avoids pulling 40 fields of TSYS host"," ","configuration per merchant."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the full configuration, read one integration directly:"]},{"$$mdtype":"Tag","name":"ReplayOpenApi","attributes":{"descriptionFile":"api-docs-apis/openapi.yaml","operationId":"getIntegration","parameters":{},"options":{},"environments":{}},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reading before updating is worth doing here. An integration update requires the"," ","complete ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["integration_details"]},", so this response is where you get the object to"," ","modify. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/platforms/connect-a-processor"},"children":["Connect a processor"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"reading-a-merchants-transactions","__idx":4},"children":["Reading a merchant's transactions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Account reports cover accounts. For payment activity, use the transaction"," ","endpoints, either with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["client_id"]}," as a filter to see one merchant inside your"," ","portfolio, or with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Acting-As-Client-Id"]}," to read as that merchant."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/after-the-payment/find-and-report-on-transactions"},"children":["Find and report on transactions"]}," ","covers the filters, and"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/platforms/act-on-behalf-of-a-client"},"children":["Act on behalf of a client"]}," covers the header."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":5},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/platforms/connect-a-processor"},"children":["Connect a processor"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/platforms/act-on-behalf-of-a-client"},"children":["Act on behalf of a client"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/after-the-payment/batch-reports"},"children":["Batch reports"]}]}]}]},"headings":[{"value":"Client reports","id":"client-reports","depth":1},{"value":"List your clients","id":"list-your-clients","depth":2},{"value":"Retrieve one client","id":"retrieve-one-client","depth":2},{"value":"Check a client's integrations","id":"check-a-clients-integrations","depth":2},{"value":"Reading a merchant's transactions","id":"reading-a-merchants-transactions","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"title":"Client reports","shortTitle":"Client reports","intro":"Read your portfolio back: which clients you own, what each one looks like, and which processors they are connected to.","type":"how-to","seo":{"title":""}},"lastModified":"2026-09-17T12:38:32.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/platforms/client-reports","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}