{"openapi":"3.0.0","info":{"title":"Reporting API","description":"<h3>An API that returns aggregated data about orders, volumes, payment methods etc.<\/h3> <hr> <section> <h3>Client authentication<\/h3> <div> <p>In order to work with our API, you need to request a JWT token using your login details, via the <code>\/api\/token\/authenticate<\/code> endpoint. This will return an authorization token, as well as a refresh token. When you have retrieved your token, you need to add it as a header to your requests:<\/p> <p><code>Authorization: Bearer {token}<\/code><\/p> <p>Tokens are valid for 1 hour. If your token has expired (or is about to expire), you can request a new one by sending the refresh token to the following endpoint: <code>\/api\/token\/refresh<\/code>. This will return a new authorization token which you can use in your requests. The refresh token will remain valid for 1 month, but that time will be reset as soon as you use it to request a new token.<\/p> <br> <\/div> <\/section>","version":"v3.7.3"},"servers":[{"url":"\/","description":""}],"paths":{"\/api\/clients\/{slug}":{"get":{"operationId":"getClientItem","tags":["Client info"],"responses":{"200":{"description":"Client resource","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Client"}},"application\/ld+json":{"schema":{"$ref":"#\/components\/schemas\/Client.jsonld"}},"text\/html":{"schema":{"$ref":"#\/components\/schemas\/Client"}}}},"404":{"description":"Resource not found"}},"summary":"Retrieves information about the authenticated client.","description":"Retrieves information about the authenticated client.","parameters":[{"name":"slug","in":"path","description":"Resource identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false},"parameters":[]},"\/api\/coin-to-fiat-orders\/{id}":{"parameters":[]},"\/api\/distributed\/coin-to-fiat":{"get":{"operationId":"getCoinToFiatOrderCollection","tags":["Distributed data"],"responses":{"200":{"description":"CoinToFiatOrder collection","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/CoinToFiatOrder.CoinToFiatOrderOutput-read.coin_to_fiat"}}},"application\/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/CoinToFiatOrder.CoinToFiatOrderOutput.jsonld-read.coin_to_fiat"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","hydra:first":"string","hydra:last":"string","hydra:previous":"string","hydra:next":"string"}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text\/html":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/CoinToFiatOrder.CoinToFiatOrderOutput-read.coin_to_fiat"}}}}}},"summary":"Retrieves all coin to fiat orders of the authenticated partner","description":"Retrieves all coin to fiat orders of the authenticated partner","parameters":[{"name":"status.status","in":"query","description":"Filter by status","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string","enum":["Pending","Confirmed","Order Placed","Order Completed","Cancelled","Ready To Send","Order Rejected"]},"style":"form","explode":false,"allowReserved":false,"example":"Pending"},{"name":"startTime[before]","in":"query","description":"Filter start time before or equal to a certain date-time ","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string","format":"date-time"},"style":"form","explode":false,"allowReserved":false,"example":"2023-01-01T00:00:00"},{"name":"startTime[strictly_before]","in":"query","description":"Filter start time before a certain date-time","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string","format":"date-time"},"style":"form","explode":false,"allowReserved":false,"example":"2023-01-01T00:00:00"},{"name":"startTime[after]","in":"query","description":"Filter start time after or equal a certain date-time","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string","format":"date-time"},"style":"form","explode":false,"allowReserved":false,"example":"2023-01-01T00:00:00"},{"name":"startTime[strictly_after]","in":"query","description":"Filter start time after a certain date-time","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string","format":"date-time"},"style":"form","explode":false,"allowReserved":false,"example":"2023-01-01T00:00:00"},{"name":"page","in":"query","description":"The page number for pagination","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"integer","minimum":1,"default":1},"style":"form","explode":false,"allowReserved":false,"example":"1"},{"name":"itemsPerPage","in":"query","description":"The number of items per page for pagination, maximum 100","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50},"style":"form","explode":false,"allowReserved":false,"example":"50"},{"name":"id","in":"query","description":"The unique order id, generated by BTC Direct","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"integer","minimum":1},"style":"form","explode":false,"allowReserved":false,"example":"1337"},{"name":"partnerOrderIdentifier","in":"query","description":"The unique identifier, generated by the partner.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"12345"}],"deprecated":false},"parameters":[]},"\/api\/distributed\/fiat-to-coin":{"get":{"operationId":"getFiatToCoinOrderCollection","tags":["Distributed data"],"responses":{"200":{"description":"FiatToCoinOrder collection","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/FiatToCoinOrder.FiatToCoinOrderOutput-read.fiat_to_coin"}}},"application\/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/FiatToCoinOrder.FiatToCoinOrderOutput.jsonld-read.fiat_to_coin"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","hydra:first":"string","hydra:last":"string","hydra:previous":"string","hydra:next":"string"}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text\/html":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/FiatToCoinOrder.FiatToCoinOrderOutput-read.fiat_to_coin"}}}}}},"summary":"Retrieves all fiat to coin orders of the authenticated partner","description":"Retrieves all fiat to coin orders of the authenticated partner","parameters":[{"name":"status.status","in":"query","description":"Filter by status","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string","enum":["Pending","Confirmed","Order Placed","Order Completed","Cancelled","Ready To Send","Order Rejected"]},"style":"form","explode":false,"allowReserved":false,"example":"Pending"},{"name":"startTime[before]","in":"query","description":"Filter start time before or equal to a certain date-time ","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string","format":"date-time"},"style":"form","explode":false,"allowReserved":false,"example":"2023-01-01T00:00:00"},{"name":"startTime[strictly_before]","in":"query","description":"Filter start time before a certain date-time","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string","format":"date-time"},"style":"form","explode":false,"allowReserved":false,"example":"2023-01-01T00:00:00"},{"name":"startTime[after]","in":"query","description":"Filter start time after or equal a certain date-time","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string","format":"date-time"},"style":"form","explode":false,"allowReserved":false,"example":"2023-01-01T00:00:00"},{"name":"startTime[strictly_after]","in":"query","description":"Filter start time after a certain date-time","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string","format":"date-time"},"style":"form","explode":false,"allowReserved":false,"example":"2023-01-01T00:00:00"},{"name":"page","in":"query","description":"The page number for pagination","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"integer","minimum":1,"default":1},"style":"form","explode":false,"allowReserved":false,"example":"1"},{"name":"itemsPerPage","in":"query","description":"The number of items per page for pagination, maximum 100","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":50},"style":"form","explode":false,"allowReserved":false,"example":"50"},{"name":"id","in":"query","description":"The unique order id, generated by BTC Direct","required":false,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"integer","minimum":1},"style":"form","explode":false,"allowReserved":false,"example":"1337"},{"name":"partnerOrderIdentifier","in":"query","description":"The unique identifier, generated by the partner.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"12345"}],"deprecated":false},"parameters":[]},"\/api\/fiat-to-coin-orders\/{id}":{"parameters":[]},"\/api\/orders":{"get":{"operationId":"getOrdersCollection","tags":["Aggregated data"],"responses":{"200":{"description":"Orders collection","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Orders"}}},"application\/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/Orders.jsonld"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","hydra:first":"string","hydra:last":"string","hydra:previous":"string","hydra:next":"string"}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text\/html":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Orders"}}}}}},"summary":"Retrieves aggregated order data between start and end date.","description":"Retrieves aggregated order data between start and end date.","parameters":[{"name":"startDate","in":"query","description":"Return results that were created after or on start date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-01"},{"name":"endDate","in":"query","description":"Return results that were created before or on end date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-30"}],"deprecated":false},"parameters":[]},"\/api\/orders-by-orderstatuses":{"get":{"operationId":"getOrdersByOrderstatusCollection","tags":["Aggregated data"],"responses":{"200":{"description":"OrdersByOrderstatus collection","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/OrdersByOrderstatus"}}},"application\/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/OrdersByOrderstatus.jsonld"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","hydra:first":"string","hydra:last":"string","hydra:previous":"string","hydra:next":"string"}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text\/html":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/OrdersByOrderstatus"}}}}}},"summary":"Retrieves aggregated orderstatus data between start and end date.","description":"Retrieves aggregated orderstatus data between start and end date.","parameters":[{"name":"startDate","in":"query","description":"Return results that were created after or on start date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-01"},{"name":"endDate","in":"query","description":"Return results that were created before or on end date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-30"}],"deprecated":false},"parameters":[]},"\/api\/orders-by-orderstatuses\/{id}":{"parameters":[]},"\/api\/orders\/{id}":{"parameters":[]},"\/api\/revenues":{"get":{"operationId":"getRevenueCollection","tags":["Aggregated data"],"responses":{"200":{"description":"Revenue collection","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Revenue"}}},"application\/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/Revenue.jsonld"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","hydra:first":"string","hydra:last":"string","hydra:previous":"string","hydra:next":"string"}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text\/html":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Revenue"}}}}}},"summary":"Retrieves aggregated revenue data between start and end date.","description":"Retrieves aggregated revenue data between start and end date.","parameters":[{"name":"startDate","in":"query","description":"Return results that were created after or on start date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-01"},{"name":"endDate","in":"query","description":"Return results that were created before or on end date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-30"}],"deprecated":false},"parameters":[]},"\/api\/revenues\/{id}":{"parameters":[]},"\/api\/token\/authenticate":{"ref":"JWT Token","post":{"operationId":"postCredentialsItem","tags":["Authenticate"],"responses":{"200":{"description":"Get JWT token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Token"}}}}},"summary":"Get JWT token to login.","description":"","parameters":[],"requestBody":{"description":"Generate new JWT Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Credentials"}}},"required":false},"deprecated":false},"parameters":[]},"\/api\/token\/refresh":{"ref":"Refresh JWT Token","post":{"operationId":"postCredentialsItem","tags":["Authenticate"],"responses":{"200":{"description":"Refresh your JWT Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Token"}}}}},"summary":"Refresh your JWT Token","description":"","parameters":[],"requestBody":{"description":"Refresh your JWT Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RefreshToken"}}},"required":false},"deprecated":false},"parameters":[]},"\/api\/volume-by-coins":{"get":{"operationId":"getVolumeByCoinsCollection","tags":["Aggregated data"],"responses":{"200":{"description":"VolumeByCoins collection","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/VolumeByCoins"}}},"application\/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/VolumeByCoins.jsonld"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","hydra:first":"string","hydra:last":"string","hydra:previous":"string","hydra:next":"string"}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text\/html":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/VolumeByCoins"}}}}}},"summary":"Retrieves aggregated volume by coin data between start and end date.","description":"Retrieves aggregated volume by coin data between start and end date.","parameters":[{"name":"startDate","in":"query","description":"Return results that were created after or on start date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-01"},{"name":"endDate","in":"query","description":"Return results that were created before or on end date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-30"}],"deprecated":false},"parameters":[]},"\/api\/volume-by-coins\/{id}":{"parameters":[]},"\/api\/volume-by-countries":{"get":{"operationId":"getVolumeByCountriesCollection","tags":["Aggregated data"],"responses":{"200":{"description":"VolumeByCountries collection","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/VolumeByCountries"}}},"application\/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/VolumeByCountries.jsonld"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","hydra:first":"string","hydra:last":"string","hydra:previous":"string","hydra:next":"string"}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text\/html":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/VolumeByCountries"}}}}}},"summary":"Retrieves aggregated volume by country data between start and end date.","description":"Retrieves aggregated volume by country data between start and end date.","parameters":[{"name":"startDate","in":"query","description":"Return results that were created after or on start date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-01"},{"name":"endDate","in":"query","description":"Return results that were created before or on end date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-30"}],"deprecated":false},"parameters":[]},"\/api\/volume-by-countries\/{id}":{"parameters":[]},"\/api\/volume-by-payment-methods":{"get":{"operationId":"getVolumeByPaymentMethodsCollection","tags":["Aggregated data"],"responses":{"200":{"description":"VolumeByPaymentMethods collection","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/VolumeByPaymentMethods"}}},"application\/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#\/components\/schemas\/VolumeByPaymentMethods.jsonld"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}},"example":{"@id":"string","type":"string","hydra:first":"string","hydra:last":"string","hydra:previous":"string","hydra:next":"string"}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text\/html":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/VolumeByPaymentMethods"}}}}}},"summary":"Retrieves aggregated volume by payment method data between start and end date.","description":"Retrieves aggregated volume by payment method data between start and end date.","parameters":[{"name":"startDate","in":"query","description":"Return results that were created after or on start date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-01"},{"name":"endDate","in":"query","description":"Return results that were created before or on end date.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false,"example":"2026-09-30"}],"deprecated":false},"parameters":[]},"\/api\/volume-by-payment-methods\/{id}":{"parameters":[]}},"components":{"schemas":{"Client":{"type":"object","description":"","properties":{"slug":{"type":"string"},"name":{"type":"string"},"firstOrderDateTime":{"type":"string","format":"date-time","nullable":true},"lastOrderDateTime":{"type":"string","format":"date-time","nullable":true}}},"Client.jsonld":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"slug":{"type":"string"},"name":{"type":"string"},"firstOrderDateTime":{"type":"string","format":"date-time","nullable":true},"lastOrderDateTime":{"type":"string","format":"date-time","nullable":true}}},"CoinToFiatOrder.CoinToFiatOrderOutput-read.coin_to_fiat":{"type":"object","description":"","properties":{"id":{"description":"The order identifier on the side of BTC Direct","example":"123","type":"integer"},"partnerOrderIdentifier":{"description":"The order identifier on the side of the partner","example":"1234567890","type":"string","nullable":true},"status":{"anyOf":[{"$ref":"#\/components\/schemas\/TransactionStatus-read.coin_to_fiat"}],"nullable":true},"startTime":{"description":"The start time of the transaction","example":"2009-01-03T19:15:05:00:00+00:00","type":"string","format":"date-time","nullable":true},"orderedAmount":{"description":"The amount of coins ordered","example":"100.00","type":"string","nullable":true},"receivedAmount":{"description":"The amount of coins ordered received","example":"0.01","type":"string","nullable":true},"currencyCode":{"description":"The type of coin","example":"btc","type":"string","nullable":true},"networkFee":{"description":"The network fee in euro","example":"0.34","type":"number","nullable":true},"btcDirectFee":{"description":"The fee charged by BTC Direct in euro","example":"0.25","type":"number","nullable":true},"partnerFee":{"description":"The fee charged by the partner in euro","example":"0.50","type":"number","nullable":true},"transactionId":{"description":"The transaction id on the blockchain","example":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","type":"string","nullable":true},"walletAddress":{"description":"The wallet address of the user","example":"04678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4cef38c4f35504e51ec112de5c384df7ba0b8d578a4c702b6bf11d5f","type":"string","nullable":true},"fiatAmount":{"description":"The amount of fiat","example":"100.00","type":"string","nullable":true},"fiatCurrency":{"description":"The currency of the fiat amount","example":"EUR","type":"string","nullable":true},"country":{"description":"The country of the user","example":"NL","type":"string","nullable":true}}},"CoinToFiatOrder.CoinToFiatOrderOutput.jsonld-read.coin_to_fiat":{"type":"object","description":"","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"description":"The order identifier on the side of BTC Direct","example":"123","type":"integer"},"partnerOrderIdentifier":{"description":"The order identifier on the side of the partner","example":"1234567890","type":"string","nullable":true},"status":{"anyOf":[{"$ref":"#\/components\/schemas\/TransactionStatus.jsonld-read.coin_to_fiat"}],"nullable":true},"startTime":{"description":"The start time of the transaction","example":"2009-01-03T19:15:05:00:00+00:00","type":"string","format":"date-time","nullable":true},"orderedAmount":{"description":"The amount of coins ordered","example":"100.00","type":"string","nullable":true},"receivedAmount":{"description":"The amount of coins ordered received","example":"0.01","type":"string","nullable":true},"currencyCode":{"description":"The type of coin","example":"btc","type":"string","nullable":true},"networkFee":{"description":"The network fee in euro","example":"0.34","type":"number","nullable":true},"btcDirectFee":{"description":"The fee charged by BTC Direct in euro","example":"0.25","type":"number","nullable":true},"partnerFee":{"description":"The fee charged by the partner in euro","example":"0.50","type":"number","nullable":true},"transactionId":{"description":"The transaction id on the blockchain","example":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","type":"string","nullable":true},"walletAddress":{"description":"The wallet address of the user","example":"04678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4cef38c4f35504e51ec112de5c384df7ba0b8d578a4c702b6bf11d5f","type":"string","nullable":true},"fiatAmount":{"description":"The amount of fiat","example":"100.00","type":"string","nullable":true},"fiatCurrency":{"description":"The currency of the fiat amount","example":"EUR","type":"string","nullable":true},"country":{"description":"The country of the user","example":"NL","type":"string","nullable":true}}},"CoinVolume":{"type":"object","description":"","properties":{"coin":{"type":"string"},"totalCoinToFiatvolume":{"type":"number"},"totalFiatToCoinvolume":{"type":"number"},"caip19":{"type":"string","nullable":true}}},"CoinVolume.jsonld":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"coin":{"type":"string"},"totalCoinToFiatvolume":{"type":"number"},"totalFiatToCoinvolume":{"type":"number"},"caip19":{"type":"string","nullable":true}}},"CountryVolume":{"type":"object","description":"","properties":{"countryCode":{"type":"string"},"countryName":{"type":"string"},"totalCoinToFiatvolume":{"type":"number"},"totalFiatToCoinvolume":{"type":"number"}}},"CountryVolume.jsonld":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"countryCode":{"type":"string"},"countryName":{"type":"string"},"totalCoinToFiatvolume":{"type":"number"},"totalFiatToCoinvolume":{"type":"number"}}},"DateRange":{"type":"object","description":"","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"}}},"DateRange.jsonld":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"}}},"FiatToCoinOrder.FiatToCoinOrderOutput-read.fiat_to_coin":{"type":"object","description":"","properties":{"id":{"description":"The order identifier on the side of BTC Direct","example":"123","type":"integer"},"partnerOrderIdentifier":{"description":"The order identifier on the side of the partner","example":"1234567890","type":"string","nullable":true},"status":{"anyOf":[{"$ref":"#\/components\/schemas\/TransactionStatus-read.fiat_to_coin"}],"nullable":true},"startTime":{"description":"The start time of the transaction","example":"2009-01-03T19:15:05:00:00+00:00","type":"string","format":"date-time","nullable":true},"requestedAmount":{"description":"The amount of coins ordered","example":"0.01","type":"string","nullable":true},"deliveredAmount":{"description":"The amount of coins delivered","example":"0.01","type":"string","nullable":true},"currencyCode":{"description":"The type of coin","example":"btc","type":"string","nullable":true},"networkFee":{"description":"The network fee in euro","example":"0.34","type":"number","nullable":true},"paymentMethod":{"description":"The payment method used","example":"ideal","type":"string","nullable":true},"paymentFee":{"description":"The payment fee in euro","example":"1.34","type":"number","nullable":true},"btcDirectFee":{"description":"The fee charged by BTC Direct in euro","example":"0.25","type":"number","nullable":true},"partnerFee":{"description":"The fee charged by the partner in euro","example":"0.50","type":"number","nullable":true},"transactionId":{"description":"The transaction identifier on the blockchain","example":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","type":"string","nullable":true},"walletAddress":{"description":"The wallet address of the user","example":"04678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4cef38c4f35504e51ec112de5c384df7ba0b8d578a4c702b6bf11d5f","type":"string","nullable":true},"fiatAmount":{"description":"The amount of fiat","example":"100.00","type":"string","nullable":true},"fiatCurrency":{"description":"The currency of the fiat amount","example":"EUR","type":"string","nullable":true},"country":{"description":"The country of the user","example":"NL","type":"string","nullable":true}}},"FiatToCoinOrder.FiatToCoinOrderOutput.jsonld-read.fiat_to_coin":{"type":"object","description":"","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"id":{"description":"The order identifier on the side of BTC Direct","example":"123","type":"integer"},"partnerOrderIdentifier":{"description":"The order identifier on the side of the partner","example":"1234567890","type":"string","nullable":true},"status":{"anyOf":[{"$ref":"#\/components\/schemas\/TransactionStatus.jsonld-read.fiat_to_coin"}],"nullable":true},"startTime":{"description":"The start time of the transaction","example":"2009-01-03T19:15:05:00:00+00:00","type":"string","format":"date-time","nullable":true},"requestedAmount":{"description":"The amount of coins ordered","example":"0.01","type":"string","nullable":true},"deliveredAmount":{"description":"The amount of coins delivered","example":"0.01","type":"string","nullable":true},"currencyCode":{"description":"The type of coin","example":"btc","type":"string","nullable":true},"networkFee":{"description":"The network fee in euro","example":"0.34","type":"number","nullable":true},"paymentMethod":{"description":"The payment method used","example":"ideal","type":"string","nullable":true},"paymentFee":{"description":"The payment fee in euro","example":"1.34","type":"number","nullable":true},"btcDirectFee":{"description":"The fee charged by BTC Direct in euro","example":"0.25","type":"number","nullable":true},"partnerFee":{"description":"The fee charged by the partner in euro","example":"0.50","type":"number","nullable":true},"transactionId":{"description":"The transaction identifier on the blockchain","example":"4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b","type":"string","nullable":true},"walletAddress":{"description":"The wallet address of the user","example":"04678afdb0fe5548271967f1a67130b7105cd6a828e03909a67962e0ea1f61deb649f6bc3f4cef38c4f35504e51ec112de5c384df7ba0b8d578a4c702b6bf11d5f","type":"string","nullable":true},"fiatAmount":{"description":"The amount of fiat","example":"100.00","type":"string","nullable":true},"fiatCurrency":{"description":"The currency of the fiat amount","example":"EUR","type":"string","nullable":true},"country":{"description":"The country of the user","example":"NL","type":"string","nullable":true}}},"OrderTotals":{"type":"object","description":"","properties":{"totalOrdersPercentage":{"type":"number"},"totalUsersWithOrdersPercentage":{"type":"number"}}},"OrderTotals.jsonld":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"totalOrdersPercentage":{"type":"number"},"totalUsersWithOrdersPercentage":{"type":"number"}}},"Orders":{"type":"object","description":"","properties":{"coinToFiat":{"$ref":"#\/components\/schemas\/OrderTotals"},"fiatToCoin":{"$ref":"#\/components\/schemas\/OrderTotals"},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange"}}},"Orders.jsonld":{"type":"object","description":"","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"coinToFiat":{"$ref":"#\/components\/schemas\/OrderTotals.jsonld"},"fiatToCoin":{"$ref":"#\/components\/schemas\/OrderTotals.jsonld"},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange.jsonld"}}},"OrdersByOrderstatus":{"type":"object","description":"","properties":{"orderstatuses":{"type":"array","items":{"$ref":"#\/components\/schemas\/Orderstatus"}},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange"}}},"OrdersByOrderstatus.jsonld":{"type":"object","description":"","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"orderstatuses":{"type":"array","items":{"$ref":"#\/components\/schemas\/Orderstatus.jsonld"}},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange.jsonld"}}},"Orderstatus":{"type":"object","description":"","properties":{"orderstatus":{"type":"string"},"totalCoinToFiatOrders":{"type":"number"},"totalFiatToCoinOrders":{"type":"number"}}},"Orderstatus.jsonld":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"orderstatus":{"type":"string"},"totalCoinToFiatOrders":{"type":"number"},"totalFiatToCoinOrders":{"type":"number"}}},"PaymentMethodVolume":{"type":"object","description":"","properties":{"paymentMethod":{"type":"string"},"totalFiatToCoinvolume":{"type":"number"}}},"PaymentMethodVolume.jsonld":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"paymentMethod":{"type":"string"},"totalFiatToCoinvolume":{"type":"number"}}},"Revenue":{"type":"object","description":"","properties":{"totalCoinToFiatRevenue":{"type":"number"},"totalFiatToCoinRevenue":{"type":"number"},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange"}}},"Revenue.jsonld":{"type":"object","description":"","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"totalCoinToFiatRevenue":{"type":"number"},"totalFiatToCoinRevenue":{"type":"number"},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange.jsonld"}}},"TransactionStatus-read.coin_to_fiat":{"type":"object","description":""},"TransactionStatus-read.fiat_to_coin":{"type":"object","description":""},"TransactionStatus.jsonld-read.coin_to_fiat":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"}}},"TransactionStatus.jsonld-read.fiat_to_coin":{"type":"object","description":"","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http:\/\/www.w3.org\/ns\/hydra\/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"}}},"VolumeByCoins":{"type":"object","description":"","properties":{"coinVolumes":{"type":"array","items":{"$ref":"#\/components\/schemas\/CoinVolume"}},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange"}}},"VolumeByCoins.jsonld":{"type":"object","description":"","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"coinVolumes":{"type":"array","items":{"$ref":"#\/components\/schemas\/CoinVolume.jsonld"}},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange.jsonld"}}},"VolumeByCountries":{"type":"object","description":"","properties":{"countryVolumes":{"type":"array","items":{"$ref":"#\/components\/schemas\/CountryVolume"}},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange"}}},"VolumeByCountries.jsonld":{"type":"object","description":"","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"countryVolumes":{"type":"array","items":{"$ref":"#\/components\/schemas\/CountryVolume.jsonld"}},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange.jsonld"}}},"VolumeByPaymentMethods":{"type":"object","description":"","properties":{"paymentMethodVolumes":{"type":"array","items":{"$ref":"#\/components\/schemas\/PaymentMethodVolume"}},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange"}}},"VolumeByPaymentMethods.jsonld":{"type":"object","description":"","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"paymentMethodVolumes":{"type":"array","items":{"$ref":"#\/components\/schemas\/PaymentMethodVolume.jsonld"}},"id":{"writeOnly":true,"type":"integer"},"dateRange":{"$ref":"#\/components\/schemas\/DateRange.jsonld"}}},"Token":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"refreshToken":{"type":"string","readOnly":true}}},"RefreshToken":{"type":"object","properties":{"refreshToken":{"type":"string","example":"refreshToken"}}},"Credentials":{"type":"object","properties":{"username":{"type":"string","example":"username"},"password":{"type":"string","example":"password"}}}},"responses":{},"parameters":{},"examples":{},"requestBodies":{},"headers":{},"securitySchemes":{"JWT":{"type":"apiKey","description":"Value for the Authorization header parameter.","name":"Authorization","in":"header"}}},"security":[{"JWT":[]}],"tags":[]}