Payments History

Use the following endpoint to retrieve detailed information about payments, including amounts, transactions, conversions, and notifications.

GEThttps://api.qa.devs.beadpay.io/Payments/info/history

Authorization

Bearer

Query parameters

Header parameters

Response

200400500

Body

application/json

dataarray of PaymentInfo (object)

totalinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('https://api.qa.devs.beadpay.io/Payments/info/history', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "data": [
    {
      "id": "text",
      "created": "2024-09-16T19:26:08.135Z",
      "updated": "2024-09-16T19:26:08.135Z",
      "externalId": "text",
      "terminalId": "text",
      "paymentCode": "text",
      "trackingId": "text",
      "pageId": "text",
      "statusCode": "created",
      "amounts": {
        "requested": {
          "inPaymentCurrency": {
            "amount": 0
          },
          "inRequestedCurrency": {
            "amount": 0
          }
        },
        "paid": {
          "inPaymentCurrency": {
            "amount": 0
          }
        },
        "settleableAmount": {
          "amount": 0
        },
        "partnerFees": [
          {
            "formula": {
              "feeFactor": 0
            },
            "ownerId": "text"
          }
        ]
      },
      "reference": "text",
      "description": "text",
      "customerId": "text",
      "emailReceipt": false,
      "smsReceipt": false,
      "cartItems": [
        {
          "id": "text",
          "name": "text",
          "price": 0
        }
      ],
      "expiration": "2024-09-16T19:26:08.135Z",
      "quoteExpiration": "2024-09-16T19:26:08.135Z",
      "paymentAddress": "text",
      "redirectUrl": "text",
      "paymentUrlType": "web",
      "transactions": [
        {
          "statusCode": "pendingExact",
          "fromAddress": "text",
          "toAddress": "text",
          "txId": "text",
          "receivedTime": "2024-09-16T19:26:08.135Z",
          "amountInfo": {
            "amount": 0
          },
          "trackingUrl": "text"
        }
      ],
      "conversions": [
        {
          "statusCode": "quoted",
          "priceQuoteId": "text",
          "quotedExchangeRate": 0,
          "conversionFee": 0,
          "presentedExchangeRate": 0,
          "quoteId": "text",
          "tradeId": "text",
          "invoiceId": "text",
          "activePaymentInstructionId": "text",
          "paymentInstructionIds": [
            "text"
          ],
          "executedExchangeRate": 0,
          "tradeFee": 0,
          "amountToConvertInfo": {
            "amount": 0
          },
          "convertedAmountInfo": {
            "amount": 0
          },
          "exchangeGain": {
            "amount": 0
          },
          "conversionTime": "2024-09-16T19:26:08.135Z"
        }
      ],
      "paymentSettlementStatusCode": "created",
      "paymentNotifications": [
        {
          "type": "firstBlockReached",
          "email": "text",
          "status": "pending",
          "notificationTime": "2024-09-16T19:26:08.135Z"
        }
      ],
      "webhookUrls": [
        "text"
      ],
      "refundEmail": "text"
    }
  ]
}

Parameter Descriptions:

Parameter	Description
PaymentId	Unique identifier of the payment
TerminalId	Identifier of the terminal
MerchantId	Identifier of the merchant
TrackingId	Tracking identifier
Page	Page number for pagination (default is 0)
PageSize	Number of items per page (default is 10)
From	Start date for filtering
To	End date for filtering
SortBy	Field to sort by
SortDirection	Direction of sorting (asc or desc)

Example API call using Node.js:

const axios = require('axios');

async function getPaymentHistory() {
    try {
        const response = await axios.get('https://api.example.com/Payments/info/history', {
            params: {
                PaymentId: '12345',
                TerminalId: '67890',
                Page: 1,
                PageSize: 20
                // Add more query parameters as needed
            },
            headers: {
                'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
            }
        });
        console.log(response.data);
    } catch (error) {
        console.error('Error fetching payment history:', error);
    }
}

getPaymentHistory();

Example API call using JAVA:

import okhttp3.HttpUrl;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

import java.io.IOException;

public class ApiClient {
    private static final String BASE_URL = "https://api.example.com/Payments/info/history";
  public static void main(String[] args) {
    OkHttpClient client = new OkHttpClient();
    HttpUrl.Builder urlBuilder = HttpUrl.parse(BASE_URL).newBuilder();
    urlBuilder.addQueryParameter("PaymentId", "12345");
    urlBuilder.addQueryParameter("TerminalId", "67890");
    urlBuilder.addQueryParameter("Page", "1");
    urlBuilder.addQueryParameter("PageSize", "20");
    // Add more query parameters as needed

    String url = urlBuilder.build().toString();
    Request request = new Request.Builder()
            .url(url)
            .header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            .build();

    try (Response response = client.newCall(request).execute()) {
        if (!response.isSuccessful()) {
            throw new IOException("Unexpected code " + response);
        }

        System.out.println(response.body().string());
    } catch (IOException e) {
        e.printStackTrace();
    }
}
}