Get Merchant Statements

Changed on

This API endpoint is designed to retrieve merchant statement data for multiple merchants for a specific month. The data includes transaction details, fees, and other relevant financial information for each merchant during the given processing month.

get/v1/merchant-statements-data/{date}

Request

  • Base URL
    https://testapi.payarc.net
  • URL
    https://testapi.payarc.net/v1/merchant-statements-data/{date}
  • Auth
    API key in header Authorization

Path parameters

datestring date required

Headers

Authorizationstring

Bearer {your_token}

Response

200

Example response

{
  "data": [
    {
      "header": {
        "BANK": "1234",
        "REMIT_NAME": "PAYARC",
        "REMIT_ADDR1": "123 W FIRST AVE",
        "REMIT_ADDR2": "SUITE 123",
        "REMIT_ADDR3": "NEW YORK NY 05533",
        "ROUTING_NUM": "xxxxx1234",
        "MAILING_NAME": "MINDFUL TECH, LLC",
        "MERCHANT_NUM": "123",
        "MAILING_ADDR2": "123 7TH AVE",
        "MAILING_ADDR3": "NEW YORK NY 10001-1001",
        "AMOUNT_CREDITED": " ",
        "AMOUNT_DEDUCTED": "$1200.41",
        "ASSOCIATION_NUM": "123456",
        "DEPOSIT_ACCT_NUM": "xxxxxxxxxxx123",
        "PROCESSING_MONTH": "01-25",
        "MINIMUM_DISCOUNT_FEE": " "
      },
      "deposits": {
        "items": [
          {
            "day": "02",
            "num_sales": "49",
            "plan_type": "T",
            "ref_number": "900017123123",
            "net_deposit": "15,005.95",
            "dollar_sales": "15,005.95",
            "discount_paid": ".00",
            "dollar_credits": ".00",
            "transaction_type": "D"
          }
        ],
        "totals": {
          "num_sales": "54",
          "net_deposit": "6,101.17",
          "dollar_sales": "6,101.17",
          "discount_paid": ".00",
          "dollar_credits": ".00"
        }
      },
      "fees_section": {
        "totals": {
          "fees_due": "$13,000.41",
          "amt_deducted": "$13,000.41"
        },
        "auth_fees": {
          "items": [
            {
              "count": "2,573",
              "total": "257.30",
              "fees_paid": ".00",
              "rate_item": "0.10000",
              "description": "Card Transaction Fees"
            }
          ],
          "total": "257.300000"
        },
        "other_fees": {
          "items": [
            {
              "total": "10.75",
              "fees_paid": ".00",
              "description": "PCI Compliance Fee"
            }
          ],
          "total": "502.900000"
        },
        "total_fees_due": "$13,206.41",
        "card_brand_fees": {
          "items": [
            {
              "count": "15",
              "total": ".29",
              "fees_paid": ".00",
              "rate_item": "0.01950",
              "description": "VS NAPF Domestic CR Authorization"
            }
          ],
          "total": "1241.150000"
        },
        "interchange_fees": {
          "items": [
            {
              "count": "01",
              "total": "26.48",
              "amount": "1199.05",
              "fees_paid": ".00",
              "rate_item": "0.10000",
              "rate_perc": "  2.2000",
              "description": "MC Merit1 CR"
            }
          ],
          "total": "9754.210000"
        },
        "transaction_fees": {
          "items": [
            {
              "count": "48",
              "total": "1,440.00",
              "amount": "8283.42",
              "fees_paid": ".00",
              "rate_item": "30.00000",
              "description": "Chargeback Fees"
            }
          ],
          "total": "1450.850000"
        }
      },
      "plan_summary": {
        "items": [
          {
            "net_sales": ".00",
            "num_sales": "00",
            "plan_code": "VS",
            "avg_ticket": ".00",
            "num_credits": "00",
            "discount_due": ".00",
            "dollar_sales": ".00",
            "dollar_credits": ".00"
          }
        ],
        "totals": {
          "disc_pi": " ",
          "percent": " ",
          "net_sales": "432.42",
          "num_sales": "2,233",
          "plan_code": "**",
          "avg_ticket": "193.91",
          "num_credits": "00",
          "discount_due": ".00",
          "dollar_sales": "432.42",
          "dollar_credits": ".00"
        }
      },
      "merchant_number": "12345",
      "processing_month_year": "01-25"
    }
  ]
}

Changes