Breew Product Documentation
  • 🤗Welcome!
  • Introduction
    • 🍵What is Cryptea?
    • ❔FAQs
    • 📞Connect with Us
  • Product
    • ☕Getting started
    • 🪙Setting up your wallets
    • 1️Creating your account
    • 2️Creating your payment link
      • Editing your payment links
      • Editing your link templates
  • Features
    • 🔗Payment Links
      • 📊Payment link overview
      • ⚙️Payment link settings
      • 🎨Payment link templates
    • ↗️On-ramp (coming soon)
    • ↙️Off-ramp (coming soon)
  • API
    • 🚀Quick Start
    • 🔗API Reference
      • Transactions
      • Users
      • Subscription Data
      • One-time payments
      • Specific payment data
    • ‼️Error codes, and how to fix them
  • SDKs
    • Coming soon
Powered by GitBook
On this page
  • Get link payments
  • Get link payments made to the link
  • Get active subscriptions
  • Get link active subscriptions, if link supports subscriptions
  • Get expired subscriptions
  • Get link expired subscriptions, if link supports subscriptions
  • Show payment data
  • Returns data for payment through id
  1. API
  2. API Reference

Transactions

Getting transaction details

Good to know: link api key should be specified under API_KEY header

Get link payments

Get link payments made to the link

GET https://ab.cryptea.me/pay/{linkname}/payments/{type}

{type} - sub, onetime or both

Query Parameters

Name
Type
Description

perPage

Number

number of payments per page. Default 10

Headers

Name
Type
Description

API_KEY

String

key required for secured link

{
    "error": false,
    "data": {
        "current_page": 1,
        "data": [
        {
            "id": 1,
            "data": "[]",
            "address": "10340293",
            "token": "matic",
            "amount": "10",
            "amountCrypto": "100",
            "type": "onetime",
            "hash": null,
            "created_at": "2022-09-25 01:32:19"
        }
        ],
        "first_page_url": "",
        "from": 1,
        "last_page": 2,
        "last_page_url": "",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "",
                "label": "1",
                "active": true
            },
            {
                "url": "",
                "label": "2",
                "active": false
            },
            {
                "url": "",
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": "",
        "path": "",
        "per_page": 10,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}
{
    "error": true,
    "message": "unauthorized"
}
{
    "error": true,
    "message": ""
}

Get active subscriptions

Get link active subscriptions, if link supports subscriptions

GET https://ab.cryptea.me/pay/{linkname}/payments/sub/active

Query Parameters

Name
Type
Description

perPage

Number

number of items per page. Default 10

Headers

Name
Type
Description

API_KEY

string

key required for secured links

{
    "error": false,
    "data": {
        "current_page": 1,
        "data": [
        {
            "id": 1,
            "data": "[]",
            "address": "10340293",
            "token": "matic",
            "amount": "10",
            "amountCrypto": "100",
            "type": "onetime",
            "hash": null,
            "created_at": "2022-09-25 01:32:19"
            "expire": null,
        }
        ],
        "first_page_url": "",
        "from": 1,
        "last_page": 2,
        "last_page_url": "",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "",
                "label": "1",
                "active": true
            },
            {
                "url": "",
                "label": "2",
                "active": false
            },
            {
                "url": "",
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": "",
        "path": "",
        "per_page": 10,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}
{
    "error": true,
    "message": "unauthorized access"
}

Get expired subscriptions

Get link expired subscriptions, if link supports subscriptions

GET https://ab.cryptea.me/pay/{linkname}/payments/sub/expired

Query Parameters

Name
Type
Description

perPage

Number

number of items per page. Default 10

Headers

Name
Type
Description

API_KEY

String

key required for secured links

{
    "error": false,
    "data": {
        "current_page": 1,
        "data": [
        {
            "id": 1,
            "data": "[]",
            "address": "10340293",
            "token": "matic",
            "amount": "10",
            "amountCrypto": "100",
            "type": "onetime",
            "hash": null,
            "created_at": "2022-09-25 01:32:19"
            "expire": null,
        }
        ],
        "first_page_url": "",
        "from": 1,
        "last_page": 2,
        "last_page_url": "",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "",
                "label": "1",
                "active": true
            },
            {
                "url": "",
                "label": "2",
                "active": false
            },
            {
                "url": "",
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": "",
        "path": "",
        "per_page": 10,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}
{
    "error": false,
    "message": "unauthorized access"
}

Show payment data

Returns data for payment through id

GET https://ab.cryptea.me/pay{linkname}/{id}

Path Parameters

Name
Type
Description

id*

Alphanumeric

Id of requested payment data

linkname*

alphanumeric

name of link

Headers

Name
Type
Description

API_KEY

String

key required for secured links

{
    "error": false,
    "data": {
            "id": 1,
            "data": "[]",
            "address": "10340293",
            "token": "matic",
            "amount": "10",
            "amountCrypto": "100",
            "type": "onetime",
            "hash": null,
            "created_at": "2022-09-25 01:32:19"
        }
}
{
    "error": true,
    "message": "data not found"
}
{
    "error": true,
    "message": "unauthorized access"
}

PreviousAPI ReferenceNextUsers

Last updated 2 years ago

🔗