Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/alviere:alviere-reporting-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 0.0.3
title: Alviere Reporting API
contact:
email: support@alviere.com
url: http://alviere.com/
x-logo:
url: img/alviere-logo.svg
description: '# Introduction
Welcome to Alviere!
This page provides developer API documentation for integrating into the Alviere platform.
### Notes
* All times are in UTC time standard
* All date fields use the RFC 3339 version of the ISO-8601 standard format'
servers:
- url: https://api.snd.alviere.com
description: Alviere API
tags:
- name: Reporting
description: 'Use the Reporting API to get all transactions processed by Alviere and to check the statuses of transactions, such as their settlement status.
Below are the statuses that will be returned from the API on the `status` property:
| Status | Description |
|--------|-------------|
| **CREATED** | We have received the transaction and accepted it for processing. |
| **IN_TRANSIT** | The transaction has been authorized by the network and has not yet settled.|
| **FAILED** | The transaction authorization has failed; the details of the reason for the failure will be in the details of the response. |
| **VOIDED** | This transaction was voided by the merchant before it settled. |
| **SETTLED** | The transaction has been settled and the funds are on their way to the merchant''s banks. |
| **COMPLETED** | This is a status that happens after the settlement (ie. transactions in this status are already settled); in future versions of the API this will mean that the webhook was called. |'
paths:
/v1/reports/payments/{uuid}:
get:
tags:
- Reporting
parameters:
- in: header
name: Authorization
required: true
description: The access token.
example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUI...
schema:
type: string
- in: path
name: uuid
description: The payment transaction identifier
required: true
schema:
format: uuid
summary: Payment transaction details
description: Retrieve payment transaction details.
responses:
'200':
description: Success
headers:
Alv-Request-Id:
description: 'Alviere''s internal unique identifier for the request. This ID is automatically generated by our API service and
spans across our entire infrastructure allowing tech ops to trace a request. This id has no business use case
and serves solely for the purpose of technical debugging and troubleshooting.
'
example: 8944355f-342d-42df-9ec9-5b12e619d504
schema:
type: string
content:
application/json:
schema:
type: object
description: The payment transaction
required:
- transaction_uuid
- type
- status
- description
- amount
- currency
- refunded
- date
properties:
transaction_uuid:
description: This field is Alviere's internal unique transaction identifier and is required to reference the transaciton that we wish to perform an operation on, such as `VOID` or `REFUND`
type: string
format: uuid
parent_transaction_uuid:
title: Parent transaction
description: 'This field is Alviere''s internal unique transaction identifier for the parent transaction of the current transaction.
In most cases, this indicates that the actual transaction was a refund of the parent.
Please note that this field will only be present, when appropriate.
'
type: string
format: uuid
type:
description: 'The payment transaction type details either the direction of funds flow such as debits or credits, or other types such as refunds.
'
type: string
enum:
- CARD_CREDIT
- CARD_REFUND
- CARD_DEBIT
- EXTERNAL_CREDIT
- WITHDRAW_FUNDS
- LOAD_FUNDS
- CARD_ISSUED_DEBIT
- CARD_ISSUED_CREDIT
- CARD_ISSUED_INITIAL
- CARD_ISSUED_RESET
- CARD_ISSUED_ATM_DEBIT
- INTERNAL_TRANSFER_CREDIT
- INTERNAL_TRANSFER_DEBIT
- BANK_CREDIT
- ADJUSTMENT
- ADJUSTMENT_ROLLBACK
- AUTO_LOAD_FUNDS
- AUTO_WITHDRAW_FUNDS
- CHARGEBACK
- CHARGEBACK_LOSS
- CHARGEBACK_REVERSAL
- CUSTOMER_CREDIT
- RECEIVE_CUSTOMER_CREDIT
- REFUND
- RETURN
- RETURN_LOSS
- RETURN_REVERSAL
- ROLLBACK
- ROLLBACK_RECEIVE
- SERVICE_FEE
- SERVICE_FEE_REVERSAL
- NEGATIVE_LOSS
- INTERNAL_PARTIAL
- TRANSFER
- INTERNATIONAL_TRANSFER
status:
description: 'The transaction status details the current status of the transaction during its life-cycle.
'
type: string
enum:
- CREATED
- PROCESSING
- IN_TRANSIT
- FAILED
- ERROR
- CANCELED
- VOIDED
- SETTLED
- COMPLETED
- PENDING
- MANUAL_REVIEW
- PROMOTED
description:
type: string
description: 'The description can be any descriptive text provided by the provider accompany the transaction.
'
amount:
type: integer
minimum: 1
maximum: 99999999
currency:
description: The currency code in ISO-4217 format.
type: string
example: USD
refunded:
description: 'This flag indicates if this transaction has been refunded.
'
type: boolean
default: false
date:
type: string
format: date-time
card_uuid:
title: The unique card uuid
type: string
format: uuid
merchant_name:
title: The Merchant name
type: string
example: Merchant
merchant_id:
title: The Merchant id
type: string
example: '1234'
'401':
description: Unauthorized
headers:
Alv-Request-Id:
description: 'Alviere''s internal unique identifier for the request. This ID is automatically generated by our API service and
spans across our entire infrastructure allowing tech ops to trace a request. This id has no business use case
and serves solely for the purpose of technical debugging and troubleshooting.
'
example: 8944355f-342d-42df-9ec9-5b12e619d504
schema:
type: string
content:
application/json:
schema:
type: object
properties:
error_code:
title: The unique error code
description: This error most likely occurred because the JWT is invalid or has expired
type: string
example: '50002'
error_description:
title: A description of the error that occurred
description: Description of the error in plain english
type: string
example: Invalid JWT access token
'403':
description: Forbidden
headers:
Alv-Request-Id:
description: 'Alviere''s internal unique identifier for the request. This ID is automatically generated by our API service and
spans across our entire infrastructure allowing tech ops to trace a request. This id has no business use case
and serves solely for the purpose of technical debugging and troubleshooting.
'
example: 8944355f-342d-42df-9ec9-5b12e619d504
schema:
type: string
content:
application/json:
schema:
type: object
properties:
error_code:
title: The unique error code
description: This error most likely occurred because you are trying to access a resource that is not authorized for your access credentials
type: string
example: '50003'
error_description:
title: A description of the error that occurred
description: Description of the error in plain english
type: string
example: Access not granted to this resource
'404':
description: Not Found
headers:
Alv-Request-Id:
description: 'Alviere''s internal unique identifier for the request. This ID is automatically generated by our API service and
spans across our entire infrastructure allowing tech ops to trace a request. This id has no business use case
and serves solely for the purpose of technical debugging and troubleshooting.
'
example: 8944355f-342d-42df-9ec9-5b12e619d504
schema:
type: string
content:
application/json:
schema:
type: object
properties:
error_code:
title: The unique error code
description: This error occurs when the object you are trying to access was not found. Please review the object uuid you are sending in this transaction
type: string
example: '50004'
error_description:
title: A description of the error that occurred
description: Description of the error in plain english
type: string
example: Resource not found
x-codeSamples:
- lang: Shell + Curl
source: "curl --request GET \\\n --url https://api.snd.alviere.com/v1/reports/payments/%7Buuid%7D \\\n --header 'Authorization: SOME_STRING_VALUE'"
- lang: Go + Native
source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.snd.alviere.com/v1/reports/payments/%7Buuid%7D\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"SOME_STRING_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
- lang: Python + Python3
source: 'import http.client
conn = http.client.HTTPSConnection("api.snd.alviere.com")
headers = { ''Authorization'': "SOME_STRING_VALUE" }
conn.request("GET", "/v1/reports/payments/%7Buuid%7D", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))'
- lang: Php + Curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => \"https://api.snd.alviere.com/v1/reports/payments/%7Buuid%7D\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: SOME_STRING_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"
- lang: Swift + Nsurlsession
source: "import Foundation\n\nlet headers = [\"Authorization\": \"SOME_STRING_VALUE\"]\n\nlet request = NSMutableURLRequest(url: NSURL(string: \"https://api.snd.alviere.com/v1/reports/payments/%7Buuid%7D\")! as URL,\n cachePolicy: .useProtocolCachePolicy,\n timeoutInterval: 10.0)\nrequest.httpMethod = \"GET\"\nrequest.allHTTPHeaderFields = headers\n\nlet session = URLSession.shared\nlet dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in\n if (error != nil) {\n print(error)\n } else {\n let httpResponse = response as? HTTPURLResponse\n print(httpResponse)\n }\n})\n\ndataTask.resume()"
operationId: getV1ReportsPaymentsByUuid
x-operation-id-source: derived
/v1/reports/payments:
get:
tags:
- Reporting
parameters:
- in: header
name: Authorization
required: true
description: The access token.
example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUI...
schema:
type: string
- in: query
name: limit
description: The number of items per page.
schema:
type: integer
minimum: 1
maximum: 500
default: 10
- in: query
description: start after offset amount of records
name: offset
schema:
type: integer
minimum: 0
default: 0
- in: query
description: Start date for search payment transactions (format YYYYMMDDhhmmss in UTC) - default is First Created Transaction date time.
name: start_date
schema:
pattern: ^(?:\d{4})(?:\d{2})(?:\d{2})(?:\d{2})(?:\d{2})(?:\d{2})$
type: string
- in: query
name: status
schema:
description: 'The transaction status details the current status of the transaction during its life-cycle.
'
type: string
enum:
- CREATED
- PROCESSING
- IN_TRANSIT
- FAILED
- ERROR
- CANCELED
- VOIDED
- SETTLED
- COMPLETED
- PENDING
- MANUAL_REVIEW
- PROMOTED
- in: query
name: type
schema:
description: 'The payment transaction type details either the direction of funds flow such as debits or credits, or other types such as refunds.
'
type: string
enum:
- CARD_CREDIT
- CARD_REFUND
- CARD_DEBIT
- EXTERNAL_CREDIT
- WITHDRAW_FUNDS
- LOAD_FUNDS
- CARD_ISSUED_DEBIT
- CARD_ISSUED_CREDIT
- CARD_ISSUED_INITIAL
- CARD_ISSUED_RESET
- CARD_ISSUED_ATM_DEBIT
- INTERNAL_TRANSFER_CREDIT
- INTERNAL_TRANSFER_DEBIT
- BANK_CREDIT
- ADJUSTMENT
- ADJUSTMENT_ROLLBACK
- AUTO_LOAD_FUNDS
- AUTO_WITHDRAW_FUNDS
- CHARGEBACK
- CHARGEBACK_LOSS
- CHARGEBACK_REVERSAL
- CUSTOMER_CREDIT
- RECEIVE_CUSTOMER_CREDIT
- REFUND
- RETURN
- RETURN_LOSS
- RETURN_REVERSAL
- ROLLBACK
- ROLLBACK_RECEIVE
- SERVICE_FEE
- SERVICE_FEE_REVERSAL
- NEGATIVE_LOSS
- INTERNAL_PARTIAL
- TRANSFER
- INTERNATIONAL_TRANSFER
summary: Transactions list
description: Show payment transaction list.
responses:
'200':
description: Success
headers:
Alv-Request-Id:
description: 'Alviere''s internal unique identifier for the request. This ID is automatically generated by our API service and
spans across our entire infrastructure allowing tech ops to trace a request. This id has no business use case
and serves solely for the purpose of technical debugging and troubleshooting.
'
example: 8944355f-342d-42df-9ec9-5b12e619d504
schema:
type: string
content:
application/json:
schema:
type: object
properties:
records:
title: Number of transaction records returned
type: integer
example: 1
transactions:
title: List of transactions
type: array
items:
type: object
description: The payment transaction
required:
- transaction_uuid
- type
- status
- description
- amount
- currency
- refunded
- date
properties:
transaction_uuid:
description: This field is Alviere's internal unique transaction identifier and is required to reference the transaciton that we wish to perform an operation on, such as `VOID` or `REFUND`
type: string
format: uuid
parent_transaction_uuid:
title: Parent transaction
description: 'This field is Alviere''s internal unique transaction identifier for the parent transaction of the current transaction.
In most cases, this indicates that the actual transaction was a refund of the parent.
Please note that this field will only be present, when appropriate.
'
type: string
format: uuid
type:
description: 'The payment transaction type details either the direction of funds flow such as debits or credits, or other types such as refunds.
'
type: string
enum:
- CARD_CREDIT
- CARD_REFUND
- CARD_DEBIT
- EXTERNAL_CREDIT
- WITHDRAW_FUNDS
- LOAD_FUNDS
- CARD_ISSUED_DEBIT
- CARD_ISSUED_CREDIT
- CARD_ISSUED_INITIAL
- CARD_ISSUED_RESET
- CARD_ISSUED_ATM_DEBIT
- INTERNAL_TRANSFER_CREDIT
- INTERNAL_TRANSFER_DEBIT
- BANK_CREDIT
- ADJUSTMENT
- ADJUSTMENT_ROLLBACK
- AUTO_LOAD_FUNDS
- AUTO_WITHDRAW_FUNDS
- CHARGEBACK
- CHARGEBACK_LOSS
- CHARGEBACK_REVERSAL
- CUSTOMER_CREDIT
- RECEIVE_CUSTOMER_CREDIT
- REFUND
- RETURN
- RETURN_LOSS
- RETURN_REVERSAL
- ROLLBACK
- ROLLBACK_RECEIVE
- SERVICE_FEE
- SERVICE_FEE_REVERSAL
- NEGATIVE_LOSS
- INTERNAL_PARTIAL
- TRANSFER
- INTERNATIONAL_TRANSFER
status:
description: 'The transaction status details the current status of the transaction during its life-cycle.
'
type: string
enum:
- CREATED
- PROCESSING
- IN_TRANSIT
- FAILED
- ERROR
- CANCELED
- VOIDED
- SETTLED
- COMPLETED
- PENDING
- MANUAL_REVIEW
- PROMOTED
description:
type: string
description: 'The description can be any descriptive text provided by the provider accompany the transaction.
'
amount:
type: integer
minimum: 1
maximum: 99999999
currency:
description: The currency code in ISO-4217 format.
type: string
example: USD
refunded:
description: 'This flag indicates if this transaction has been refunded.
'
type: boolean
default: false
date:
type: string
format: date-time
card_uuid:
title: The unique card uuid
type: string
format: uuid
merchant_name:
title: The Merchant name
type: string
example: Merchant
merchant_id:
title: The Merchant id
type: string
example: '1234'
'400':
description: Bad Request
headers:
Alv-Request-Id:
description: 'Alviere''s internal unique identifier for the request. This ID is automatically generated by our API service and
spans across our entire infrastructure allowing tech ops to trace a request. This id has no business use case
and serves solely for the purpose of technical debugging and troubleshooting.
'
example: 8944355f-342d-42df-9ec9-5b12e619d504
schema:
type: string
content:
application/json:
schema:
type: object
properties:
error_code:
title: The unique error code
description: This error mainly occurs because there is a missing or invalid property in the request payload
type: string
example: '50001'
error_description:
title: A description of the error that occurred
description: Description of the error in plain english
type: string
example: Missing required property in payload
'401':
description: Unauthorized
headers:
Alv-Request-Id:
description: 'Alviere''s internal unique identifier for the request. This ID is automatically generated by our API service and
spans across our entire infrastructure allowing tech ops to trace a request. This id has no business use case
and serves solely for the purpose of technical debugging and troubleshooting.
'
example: 8944355f-342d-42df-9ec9-5b12e619d504
schema:
type: string
content:
application/json:
schema:
type: object
properties:
error_code:
title: The unique error code
description: This error most likely occurred because the JWT is invalid or has expired
type: string
example: '50002'
error_description:
title: A description of the error that occurred
description: Description of the error in plain english
type: string
example: Invalid JWT access token
'403':
description: Forbidden
headers:
Alv-Request-Id:
description: 'Alviere''s internal unique identifier for the request. This ID is automatically generated by our API service and
spans across our entire infrastructure allowing tech ops to trace a request. This id has no business use case
and serves solely for the purpose of technical debugging and troubleshooting.
'
example: 8944355f-342d-42df-9ec9-5b12e619d504
schema:
type: string
content:
application/json:
schema:
type: object
properties:
error_code:
title: The unique error code
description: This error most likely occurred because you are trying to access a resource that is not authorized for your access credentials
type: string
example: '50003'
error_description:
title: A description of the error that occurred
description: Description of the error in plain english
type: string
example: Access not granted to this resource
x-codeSamples:
- lang: Shell + Curl
source: "curl --request GET \\\n --url 'https://api.snd.alviere.com/v1/reports/payments?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&start_date=SOME_STRING_VALUE&status=SOME_STRING_VALUE&type=SOME_STRING_VALUE' \\\n --header 'Authorization: SOME_STRING_VALUE'"
- lang: Go + Native
source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://api.snd.alviere.com/v1/reports/payments?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&start_date=SOME_STRING_VALUE&status=SOME_STRING_VALUE&type=SOME_STRING_VALUE\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"Authorization\", \"SOME_STRING_VALUE\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := ioutil.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}"
- lang: Python + Python3
source: 'import http.client
conn = http.client.HTTPSConnection("api.snd.alviere.com")
headers = { ''Authorization'': "SOME_STRING_VALUE" }
conn.request("GET", "/v1/reports/payments?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&start_date=SOME_STRING_VALUE&status=SOME_STRING_VALUE&type=SOME_STRING_VALUE", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))'
- lang: Php + Curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_URL => \"https://api.snd.alviere.com/v1/reports/payments?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&start_date=SOME_STRING_VALUE&status=SOME_STRING_VALUE&type=SOME_STRING_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => [\n \"Authorization: SOME_STRING_VALUE\"\n ],\n]);\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"
- lang: Swift + Nsurlsession
source: "import Foundation\n\nlet headers = [\"Authorization\": \"SOME_STRING_VALUE\"]\n\nlet request = NSMutableURLRequest(url: NSURL(string: \"https://api.snd.alviere.com/v1/reports/payments?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&start_date=SOME_STRING_VALUE&status=SOME_STRING_VALUE&type=SOME_STRING_VALUE\")! as URL,\n cachePolicy: .useProtocolCachePolicy,\n timeoutInterval: 10.0)\nrequest.httpMethod = \"GET\"\nrequest.allHTTPHeaderFields = headers\n\nlet session = URLSession.shared\nlet dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in\n if (error != nil) {\n print(error)\n } else {\n let httpResponse = response as? HTTPURLResponse\n print(httpResponse)\n }\n})\n\ndataTask.resume()"
operationId: getV1ReportsPayments
x-operation-id-source: derived