WePay logo
      Nothing Found

Get a collection of adjustments

get/adjustments

The GET /adjustments call allows your platform to look up a collection of adjustments. Be sure to subscribe to the adjustments.created Notification event topic in order to programmatically integrate new Adjustments that WePay makes to the merchant's Account.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
page
string

Return elements from this page.

page_size
integer [ 1 .. 50 ]
Default: 10

Return no more than this many elements per page. If not specified, page_size defaults to 10. Maximum value allowed is 50.

create_time_start
integer <int64> >= 0

The timestamp for the start of the search window.

create_time_end
integer <int64> >= 0

The timestamp for the end of the search window.

owner_id
string

Return elements owned by this resource instance.

header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
previous
required
string or null

An opaque path for the previous page of results. Perform an HTTP GET to obtain the previous page.

next
required
string or null

An opaque path for the next page of results. Perform an HTTP GET to obtain the next page.

required
Array of objects unique

An array of adjustment objects.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": "/adjustments?page=QVFQNUFBRVh4SmJxMVpwdTI4L3ArUmlvTUFQTEgzWVlHek5KNk1YZS84alpHNmsvVTF0TzVZc1VnMWRpZDRNcjJQQVNsNG41aklzR0toZ2tLVGlvUjFmSGR2Vm5OdFBaSTJvbHRxWldTWTZUb3poc1hwdm9MZHhKMW1FOHhxc05UeWFXSWRNT0k0WXowa0RDYWdaNUhGcytRZmJxR29FamY2dkk5MWFuVmppQ1MvNGVNRVJPNFdGV0JxelJFdz09",
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "amount": 1000,
      • "create_time": 1520543108,
      • "currency": "USD",
      • "custom_data": null,
      • "id": "9fed5d2f-3957-412c-9f30-efabcc2b5405",
      • "owner": {
        • "id": "46f481b3-a267-48e5-b6b6-e7685d3031f8",
        • "path": "/accounts/46f481b3-a267-48e5-b6b6-e7685d3031f8",
        • "resource": "accounts"
        },
      • "path": "/adjustments/9fed5d2f-3957-412c-9f30-efabcc2b5405",
      • "reason": {
        • "reason_code": "REIMBURSEMENTS_AND_CORRECTIONS",
        • "reason_message": "Adjustment for reimbursement or corrections.",
        • "details": [
          • {
            • "detail_code": "bank_overdraft_fee",
            • "detail_message": "Reimbursement of Bank Overdraft Fee."
            }
          ]
        },
      • "resource": "adjustments",
      • "txnr_adjustment": {
        • "id": "80027dfa-39a2-4d6e-ac7a-024c61340bc2",
        • "path": "/transaction_records/80027dfa-39a2-4d6e-ac7a-024c61340bc2",
        • "resource": "transaction_records"
        },
      • "type": "credit",
      • "api_version": "3.0"
      },
    • {
      • "amount": -1000,
      • "create_time": 1520471396,
      • "currency": "USD",
      • "custom_data": null,
      • "id": "91e3d7f6-0fe7-4f66-a414-715fbece14e2",
      • "owner": {
        • "id": "46f481b3-a267-48e5-b6b6-e7685d3031f8",
        • "path": "/accounts/46f481b3-a267-48e5-b6b6-e7685d3031f8",
        • "resource": "accounts"
        },
      • "path": "/adjustments/91e3d7f6-0fe7-4f66-a414-715fbece14e2",
      • "reason": {
        • "reason_code": "ESCHEATMENT",
        • "reason_message": "Adjustment due to abandoned funds.",
        • "details": [
          • {
            • "detail_code": "escheatment",
            • "detail_message": "Abandoned funds escheated to state of account-holder."
            }
          ]
        },
      • "resource": "adjustments",
      • "txnr_adjustment": {
        • "id": "a904c2cc-4eb1-4cba-bab5-8ff20c600f90",
        • "path": "/transaction_records/a904c2cc-4eb1-4cba-bab5-8ff20c600f90",
        • "resource": "transaction_records"
        },
      • "type": "debit",
      • "api_version": "3.0"
      },
    • {
      • "amount": 1000,
      • "create_time": 1520471380,
      • "currency": "USD",
      • "custom_data": null,
      • "id": "1020c224-b5c3-44ef-8a95-7e220e23b743",
      • "owner": {
        • "id": "46f481b3-a267-48e5-b6b6-e7685d3031f8",
        • "path": "/accounts/46f481b3-a267-48e5-b6b6-e7685d3031f8",
        • "resource": "accounts"
        },
      • "path": "/adjustments/1020c224-b5c3-44ef-8a95-7e220e23b743",
      • "reason": {
        • "reason_code": "REIMBURSEMENTS_AND_CORRECTIONS",
        • "reason_message": "Adjustment for reimbursement or corrections.",
        • "details": [
          • {
            • "detail_code": "bank_overdraft_fee",
            • "detail_message": "Reimbursement of Bank Overdraft Fee."
            }
          ]
        },
      • "resource": "adjustments",
      • "txnr_adjustment": {
        • "id": "50bcdd90-c351-4814-a16d-769bcf59ac9f",
        • "path": "/transaction_records/50bcdd90-c351-4814-a16d-769bcf59ac9f",
        • "resource": "transaction_records"
        },
      • "type": "credit",
      • "api_version": "3.0"
      }
    ]
}