BVbvnk
Crypto Payments

List payments

Changed on

Retrieves a list of payments on a specific Wallet ID.

get/api/v1/pay/summary

Request

Query parameters

walletIdstring

Unique identifier of the wallet associated with the payment.

customerReferencestring

DEPRECATED: will be removed soon. The customer reference.

paymentExternalIdstring uuid

DEPRECATED: will be removed soon. The merchant payment uuid.

uuidstring uuid

Unique identifier for the payment.

referencestring

Custom payment reference ID to link the payment to your customer.

fromDatestring
Example:2023-03-30

The start date in format 'YYYY-MM-dd'.

toDatestring
Example:2023-03-30

The end date in format 'YYYY-MM-dd'.

offsetnumber

Where to start fetching records.

maxnumber

Maximum number of items in response.

status'PENDING' | 'PROCESSING' | 'CANCELLED' | 'COMPLETE' | 'UNDERPAID' | 'OVERPAID' | 'EXPIRED'

The payment status.

Example:PENDING
order'asc' | 'desc'

Ordering direction.

Response

OK

uuidstring

Unique identifier for the merchant payment.

merchantDisplayNamestring

The display name for the merchant payment.

walletIdstring

Your wallet's ID.

dateCreatedinteger

The date and time, encoded into UNIX epoch timestamps.

expiryDateinteger

The date and time, encoded into UNIX epoch timestamps.

quoteExpiryDateinteger

Expiration date and time, encoded into UNIX epoch timestamps.

acceptanceExpiryDateinteger

Date and time, encoded into UNIX epoch timestamps.

quoteStatusstring
referencestring

Custom payment reference ID to tie the payment to your customer.

type'IN' | 'OUT'

Defines whether a payment in or payment out.

subType'merchantPayIn' | 'merchantPayOut' | 'merchantRefund'

Payment sub type.

status'PENDING' | 'PROCESSING' | 'CANCELLED' | 'COMPLETE' | 'UNDERPAID' | 'OVERPAID' | 'EXPIRED'

The payment status.

returnUrlstring

The URL that the customer will be redirected to if they click 'Back to Merchant' button on the payment web page.

redirectUrlstring

The URL to the payment page that you redirect your customers to.

refundobject

The payment this object is a refund of. This should reference the pay in that this refund was created for.

refundsobject[]

Refunds that have been requested for this payment. This should reference the refund payout for this pay in.

flowstring

Example response

[
  {
    "uuid": "3A6FAFFA-F21D-416E-B17E-2529A9BC44A0",
    "merchantDisplayName": "Test Merchant Name",
    "walletId": "acc:23040543559277:x8rvQ:0",
    "dateCreated": 1566203005000,
    "expiryDate": 1566203005000,
    "quoteExpiryDate": 1566203005000,
    "acceptanceExpiryDate": 1566203005000,
    "quoteStatus": "ACCEPTED",
    "reference": "CryptoP-333",
    "type": "IN",
    "subType": "merchantPayIn",
    "status": "PENDING",
    "displayCurrency": {
      "currency": "ETH",
      "actual": 76.45
    },
    "walletCurrency": {
      "currency": "ETH",
      "actual": 76.45
    },
    "paidCurrency": {
      "currency": "ETH",
      "actual": 76.45
    },
    "feeCurrency": {
      "currency": "ETH",
      "actual": 76.45
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 1680.1
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 1680.1
    },
    "address": {
      "address": "0xb794f5ea0ba39494ce839613fffba74279579268",
      "network": "ETHEREUM",
      "protocol": "ERC20",
      "uri": "ethereum:0xABCDabcdABcDabcDaBCDAbcdABcdAbCdABcDABCd?value=1.1e18",
      "alternatives": [
        {
          "network": "POLYGON",
          "protocol": "POLYGON",
          "address": "0x101bfbc5018b777cb531aa9d68511b96d800b9c6",
          "tag": "null",
          "uri": "polygon:0xA512f02EEa71580CBB7B5C3017F1f80A365f8329"
        }
      ]
    },
    "returnUrl": "https://my-shop.com/payment-complete?ref=xyz",
    "redirectUrl": "https://pay.bvnk.com/payin?uuid=3A6FAFFA-F21D-416E-B17E-2529A9BC44A0",
    "transactions": [
      {
        "dateCreated": 1566203005000,
        "dateConfirmed": 1566203005000,
        "amount": 100,
        "networkFeeCurrency": "BTC",
        "networkFeeAmount": 1.05,
        "sources": [
          "0xb794f5ea0ba39494ce839613fffba74279579268"
        ],
        "displayRate": {
          "base": "ETH",
          "counter": "EUR",
          "rate": 1680.1
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "EUR",
          "rate": 1680.1
        }
      }
    ],
    "currencyOptions": {
      "transaction": "https://etherscan.io/tx/{{hash}}",
      "explorer": "https://etherscan.io/",
      "address": "https://etherscan.io/address/{{address}}",
      "confirmations": 12
    },
    "networkFeeCurrency": {
      "currency": "EUR",
      "amount": 1
    },
    "flow": "DEFAULT"
  }
]

Changes

  • 97d6c0d2fe2eRevision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status