Skip to main content
GET
/
api
/
v2
/
payins
List payins
curl --request GET \
  --url https://demo.api.loopcrypto.xyz/api/v2/payins \
  --header 'Authorization: Bearer <token>'
{
  "totalResults": 100,
  "payins": [
    {
      "payinId": "8f47c6e9-2b3a-4d5c-9f8e-1a2b3c4d5e6f",
      "merchantId": "67e55044-10b1-426f-9247-bb680e5fe0c8",
      "amount": "100.00",
      "amountType": "fiat",
      "billDate": 1716211200,
      "invoiceId": "1234567890abcdef",
      "description": "Payment for Developer plan",
      "externalInvoiceRef": "1234567890abcdef",
      "externalSubscriptionRefId": "sub_1234abcd",
      "payinType": "subscription",
      "payinStatus": "scheduled",
      "transaction": {
        "transactionId": "0xcfdfbb523c079e47e9a17ba236fa978257d4331e96ec43997e974b97522047fe",
        "transactionUrl": "https://etherscan.io/tx/0xcfdfbb523c079e47e9a17ba236fa978257d4331e96ec43997e974b97522047fe",
        "amountTransferred": "1990000",
        "exchangeRate": {
          "currency": "USD",
          "price": "10000",
          "provider": "CoinMarketCap",
          "timestamp": 1715731200
        }
      },
      "paymentMethod": {
        "networkId": 1,
        "paymentMethodId": "1234567890abcdef",
        "paymentMethodName": "My Crypto Wallet",
        "active": true,
        "customer": {
          "customerId": "1234567890abcdef",
          "customerRefId": "1234567890abcdef"
        },
        "walletAddress": "0x1234567890abcdef",
        "isDefault": true,
        "token": {
          "symbol": "USDC",
          "tokenId": "123e4567-e89b-12d3-a456-426614174000",
          "address": "0x1234567890abcdef",
          "decimals": 6,
          "exchangeRates": [
            {
              "currency": "USD",
              "price": "10000",
              "provider": "CoinMarketCap",
              "timestamp": 1715731200
            }
          ]
        },
        "preAuthorization": {
          "balance": "100",
          "authorization": "49.9"
        },
        "status": "ok"
      },
      "payoutDestination": {
        "networkId": 1,
        "walletAddress": "0x1234567890abcdef",
        "payoutDestinationId": "1234567890abcdef",
        "settlementType": "Crypto"
      },
      "dateCreated": 1716211200
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
paymentMethodId
string

Optional filter to retrieve payins with a specific payment method ID. Useful for filtering payins when managing multiple payment methods

​
fromWallet
string

Optional filter to retrieve payins with a specific from wallet address. Useful for filtering payins when managing multiple wallets

​
networkId
string

Optional filter to retrieve payins with a specific network ID. Useful for filtering payins when managing multiple networks

​
merchantId
string

Optional filter to retrieve payins with a specific merchant ID. Useful for filtering payins when managing multiple merchants

​
customerId
string

Optional filter to retrieve payins with a specific customer ID. Useful for filtering payins when managing multiple customers

​
customerRefId
string

Optional filter to retrieve payins with a specific customer reference ID. Useful for filtering payins linked to external customers

​
status
string

Optional filter to retrieve payins with a specific status. Useful for filtering payins when managing multiple payins. Valid options are "scheduled", "pending", "completed", "failed", "canceled", "uncollectible", and "draft".

​
page
number

Optional pagination parameter to specify the page number of the results to return. Default is 1 which is the first page.

​
limit
number

Optional pagination parameter to specify the number of results per page. Default is 25, maximum is 100.

​
sortBy
string

Optional sorting parameter to specify the field to sort the results by. Default is "dateCreated".

​
sortDir
string

Optional sorting parameter to specify the direction to sort the results by. Valid options are "asc" and "desc". Default is "desc".

Response

Ok

​
totalResults
number
required

The total count of payins matching the search criteria, regardless of page size or number.

Example:

100

​
payins
object[]
required

The list of payins

⌘I