v1

latestOpenAPI 3.0.02026-07-242830146.7 KB

Transaction

Get transactions list

get/v2/transactions

Query parameters

fromstring date-time

Example:2022-01-01T00:00:00Z

From value in ISO 8601 full-time format. Must be passed in pair with the value to.

tostring date-time

Example:2021-01-10T23:59:59Z

To value in ISO 8601 full-time format. Must be passed in pair with the value from.

emailstring

Example:user@mail.com

User email (ignored if passed partnerUserId)

partnerUserIdstring

Example:1bc166bd-1808-4009-8454-aceb47ba8750

User ID in partners' system

invoices[]string[]

Transactions invoices.

[
  "PB20240101TX1"
]

requestIds[]string[]

Request IDs.

[
  "c647830b-703a-47ff-9961-f35107b8de4b"
]

partnerTransactionIdstring

Example:685012ea897448430c0fac55

Partner Transaction ID

gateways[]string[]

Transactions gateways.

statuses[]string[]

Transactions statuses.

currencies[]string[]

Transactions currencies.

[
  "BTC"
]

countries[]string[]

Transactions countries.

[
  "UK"
]

amountCryptonumber

Example:0.00125

Crypto amount for transaction

amountUsdnumber

Example:10.25

Amount in USD for transaction

limitnumber

Example:10

Items limit per request.

cursorstring

Example:c0JnUVJBPT18fHx8fHx8Bw+JHXBWzYstq2o9Ar79TQ==

Offset cursor for current request.

Response

Transactions list for partner

Example response

{
  "data": [
    {
      "id": "PBTESTBUYCRYPTO123",
      "gateway": "fiat_to_crypto",
      "status": "completed",
      "from": {
        "name": "Credit/Debit Card",
        "asset": null,
        "address": null,
        "destinationTag": null
      },
      "to": {
        "name": "Bitcoin",
        "asset": {
          "id": "BTC-TESTNET",
          "name": "Bitcoin Testnet",
          "currency": {
            "code": "BTC"
          },
          "blockchain": {
            "name": "bitcoin",
            "network": "testnet"
          }
        },
        "address": "tb1q0kz2yrcf6c8jszsvvqrumf23ysesht0mzpanjv",
        "destinationTag": null
      },
      "exchangeRate": {
        "currencyTo": {
          "amount": "1",
          "currency": "BTC"
        },
        "currencyFrom": {
          "amount": "52348.50515",
          "currency": "USD"
        }
      },
      "hash": "b439d744caff2234",
      "explorerLink": "https://www.blockchain.com/btc/tx/e531924260",
      "createdAt": "2024-02-20T13:45:41+00:00",
      "paidAt": "2024-02-20T13:59:59+00:00",
      "completedAt": "2024-02-20T14:02:45+00:00",
      "amounts": {
        "spentOriginal": {
          "amount": "100",
          "currency": "USD"
        },
        "spentFiat": {
          "amount": "100",
          "currency": "USD"
        },
        "receivedOriginal": {
          "amount": "0.0017407",
          "currency": "BTC"
        },
        "receivedFiat": {
          "amount": "90.19",
          "currency": "USD"
        }
      },
      "fees": {
        "paybisFee": {
          "amount": "1.04",
          "currency": "USD"
        },
        "paymentFee": {
          "amount": "4.99",
          "currency": "USD"
        },
        "networkFee": {
          "amount": "4.82",
          "currency": "USD"
        },
        "partnerFee": {
          "amount": "0.00001930",
          "currency": "USD"
        },
        "partnerFeeFiat": {
          "amount": "1.00",
          "currency": "USD"
        }
      },
      "user": {
        "id": "eb42162e-3cac-46ad-85f3-1733477d0000",
        "email": "user1@paybis.com",
        "country": {
          "name": "Austria",
          "code": "AT"
        }
      },
      "request": {
        "id": "c647830b-703a-47ff-9961-f35107b8de4b",
        "flow": "buyCrypto",
        "createdAt": "2024-02-21T16:05:43+00:00"
      }
    }
  ],
  "meta": {
    "limit": 25,
    "currentCursor": null,
    "nextCursor": "c0JnUVJBPT18fHx8fHx8Bw+JHXBWzYstq2o9Ar79TQ=="
  }
}