Follow

GET /deposits/?offset={index}

This API endpoint uses pagination.

To ensure all query results are received make sure to read our Pagination article.

Deposit information may not be available for all accounts. In order for deposit information to be available to an integrated platform, the merchant must have a merchant account underwritten by PayJunction.

Allows an integration to fetch a list of all funding activity to and from a business' checking account related to their merchant account activity. 

Production Request

curl -X GET -u "login:password" -H "Accept: application/json" -H "X-PJ-Application-Key: YOUR_PRODUCTION_APP_KEY" \
    "https://api.payjunction.com/deposits/?offset=0"

Sandbox Request

curl -X GET -u "pj-ql-01:pj-ql-01p" -H "Accept: application/json" -H "X-PJ-Application-Key: YOUR_LABS_APP_KEY" \
    "https://api.payjunctionlabs.com/deposits/?offset=0"

The above will return the first 50 records (index 0-49). To pull the next 50 records send offset=50 (index 50-99). Generally it is easiest to grab the URL in the "next" parameter returned in the response to get the correct index for the next set of records. The next field will not be set once you have reached the last page, therefore it is important to verify the parameter exists in the response before referencing it in your code (isset() in PHP and hasOwnProperty() in JavaScript).

In addition to the offset and limit query parameters supported by all paginated endpoints, the following query parameter is accepted by this endpoint:

Name Format Description
merchantNumber Numeric  Limits the results to deposits on the specified merchant account within the PayJunction account. The merchantNumbers available in an account can be obtained from the GET /terminals endpoint. 

Example Response

{
    "next": "https://api.payjunctionlabs.com/deposits/?offset=3&limit=3",
    "results": [
        {
            "depositId": "7d36ace0-d5a5-43e5-814e-99e20deb5bdd",
            "depositDate": "2018-09-11",
            "merchantNumber": "12345678",
            "merchantName": "ABC Merchant",
            "amountBatch": 6438.00,
            "amountFee": 0.00,
            "amountChargeback": 0.00,
            "amountOther": -100.00,
            "amountNet": 6338.00
        },
        {
            "depositId": "e5cb419c-faaf-4fb8-8465-0203e742981e",
            "depositDate": "2018-09-11",
            "merchantNumber": "12345678",
            "merchantName": "ABC Merchant",
            "amountBatch": 472.00,
            "amountFee": 0.00,
            "amountChargeback": 0.00,
            "amountOther": -5940.00,
            "amountNet": -5468.00
        },
        {
            "depositId": "5f660faa-11ee-4588-9b03-db1f1242f7d9",
            "depositDate": "2018-09-11",
            "merchantNumber": "12345678",
            "merchantName": "ABC Merchant",
            "amountBatch": -200.00,
            "amountFee": 0.00,
            "amountChargeback": 0.00,
            "amountOther": 100.00,
            "amountNet": -100.00
        }
    ]
}

Response Fields

Name Format Description
depositId UUID Unique identifier for the deposit in PayJunction
depositDate Date The UTC date funds should be available in the business checking account.
merchantNumber Numeric The Backend Acquirer Merchant ID (MID) representing the merchant account. PayJunction accounts can have multiple MIDs available for processing. 
merchantName String The legal business name for a merchant account. This is the name of the business as registered with the IRS and might not be the same as the Doing-Business-As name. For sole proprietorships, this will be the business owner's legal name.
amountBatch Money

If the deposit was triggered by batch settlements in the PayJunction account, the aggregate of all included settlements.

amountFee Money The fees assessed to this deposit, if any
amountChargeback Money The total amount deducted from the deposit by chargebacks.
amountOther Money The aggregate amount for other activity which can change the final deposit amount into the business checking account.
amountNet Money The final deposit amount. This should correspond to the actual deposit into the business checking account.