Get Payments

View Payments with the Swapped Commerce Dashboard, or retrieve Payments Data via API

View Payments via Dashboard

The payments dashboard contains all pending, current, and settled transaction data. From this view, you can review all payment-related details and also process refunds.

Note: To refund a payment, you must have the same crypto the customer used to pay for the order in your Merchant Balance.

This means if you don't have the crypto to refund a processed payment, you'll need to swap another asset into the refund cryptocurrency before initiating a refund.

Get Payments via API

You can access the same data available on the dashboard directly via an API. This is useful for merchants who want to update their own source of truth and easily combine it with payment integration data.

Get merchant orders

get

Get merchant orders

Authorizations

apiKey

X-API-KeystringRequired

Query parameters

pageinteger · min: 1OptionalDefault: 1

limitinteger · min: 1 · max: 100OptionalDefault: 20

searchIdstringOptional

startDateintegerOptional

endDateintegerOptional

typestring · enumOptionalPossible values:

Responses

200

Successful

*/*

get

/v1/merchants/orders

HTTPcURLJavaScriptPython

GET /v1/merchants/orders HTTP/1.1
Host: pay-api.swapped.com
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful

{
  "data": {
    "orders": [
      {
        "id": "text",
        "link": "text",
        "externalId": "text",
        "userId": "text",
        "merchant": {
          "id": "text"
        },
        "initType": "STANDARD",
        "quote": {
          "fromAmount": {
            "amount": "text",
            "currency": {
              "id": "text",
              "symbol": "text",
              "precision": 1,
              "type": "FIAT",
              "flows": [
                "PAYMENT"
              ],
              "blockchain": {
                "id": "text",
                "name": "text"
              }
            }
          },
          "toAmount": {
            "amount": "text",
            "currency": {
              "id": "text",
              "symbol": "text",
              "precision": 1,
              "type": "FIAT",
              "flows": [
                "PAYMENT"
              ],
              "blockchain": {
                "id": "text",
                "name": "text"
              }
            }
          },
          "exchangeRateSnapshotId": "text",
          "fees": [
            {
              "id": "text",
              "type": "text",
              "label": "text",
              "amount": "text",
              "currency": {
                "id": "text",
                "symbol": "text",
                "precision": 1,
                "type": "text"
              },
              "createdAt": "text"
            }
          ]
        },
        "depositAddress": {
          "id": "text",
          "address": "text",
          "available": true,
          "memo": "text",
          "supportedCurrencies": [
            {
              "name": "text",
              "officialId": "text",
              "type": "FIAT",
              "symbol": "text",
              "precision": 1,
              "flows": [
                "PAYMENT"
              ],
              "blockchain": {
                "id": "text",
                "name": "text"
              },
              "blockchainId": "text",
              "isStablecoin": true,
              "decimals": 1,
              "isNative": true,
              "id": "text"
            }
          ]
        },
        "settlements": [
          {
            "id": "text",
            "type": "text",
            "status": "text"
          }
        ],
        "expiresAt": "text",
        "createdAt": "text",
        "status": "PENDING_USER_CREATION",
        "purchase": {
          "id": "text",
          "name": "text",
          "notes": "text",
          "imageUrl": "text",
          "price": "text",
          "currency": {
            "name": "text",
            "officialId": "text",
            "type": "FIAT",
            "symbol": "text",
            "precision": 1,
            "flows": [
              "PAYMENT"
            ],
            "blockchain": {
              "id": "text",
              "name": "text"
            },
            "blockchainId": "text",
            "isStablecoin": true,
            "decimals": 1,
            "isNative": true,
            "id": "text"
          },
          "rateMerchantOverOrder": "text"
        },
        "payments": [
          {
            "id": "text",
            "orderId": "text",
            "receivedAmount": "text",
            "receivedCurrency": {
              "name": "text",
              "officialId": "text",
              "type": "FIAT",
              "symbol": "text",
              "precision": 1,
              "flows": [
                "PAYMENT"
              ],
              "blockchain": {
                "id": "text",
                "name": "text"
              },
              "blockchainId": "text",
              "isStablecoin": true,
              "decimals": 1,
              "isNative": true,
              "id": "text"
            },
            "txHash": "text",
            "confirmedAt": "text",
            "status": "text",
            "createdAt": "text",
            "depositAddress": {
              "id": "text",
              "address": "text",
              "available": true,
              "memo": "text",
              "supportedCurrencies": [
                {
                  "name": "text",
                  "officialId": "text",
                  "type": "FIAT",
                  "symbol": "text",
                  "precision": 1,
                  "flows": [
                    "PAYMENT"
                  ],
                  "blockchain": {
                    "id": "text",
                    "name": "text"
                  },
                  "blockchainId": "text",
                  "isStablecoin": true,
                  "decimals": 1,
                  "isNative": true,
                  "id": "text"
                }
              ]
            },
            "sourceAddress": "text",
            "fireblocksTxId": "text"
          }
        ],
        "updates": [
          {
            "id": "text",
            "message": "text",
            "entityType": "text",
            "authorId": "text",
            "metadata": {},
            "timestamp": "text"
          }
        ],
        "metadata": {
          "externalId": "text",
          "userId": "text",
          "userName": "text",
          "userLang": "text",
          "userCountry": "text",
          "userEmail": "text",
          "redirectUrl": "text"
        },
        "preferredPayCurrency": {
          "name": "text",
          "officialId": "text",
          "type": "FIAT",
          "symbol": "text",
          "precision": 1,
          "flows": [
            "PAYMENT"
          ],
          "blockchain": {
            "id": "text",
            "name": "text"
          },
          "blockchainId": "text",
          "isStablecoin": true,
          "decimals": 1,
          "isNative": true,
          "id": "text"
        }
      }
    ],
    "pagination": {
      "currentPage": 1,
      "totalPages": 1,
      "totalItems": 1,
      "itemsPerPage": 1
    }
  },
  "message": "text",
  "success": true
}