July 26, 2023

Schema Update for Settlement API

On August 21, 2023, several fields that are currently deprecated are going to be removed from the Settlement API response. Their replacements are currently available in the API for your use.

Summary Endpoint

Field	Change
`settled_gross_amount`	To be removed - renamed to `transactions_gross_amount`
`dispute_gross_amount`	To be removed - renamed to `disputes_gross_amount`
`settled_net_details`	To be removed - data available in the `details` field
`settled_gross_details`	To be removed - data available in the `details` field
`interchange_details`	To be removed - data available in the `details` field
`disputes_details`	To be removed - data available in the `details` field
`other_fees_details`	To be removed - data available in the `details` field
`exception_gross_amount`	To be removed - currently unpopulated
`exception_gross_details`	To be removed - currently unpopulated

New Summary Response

{
  "currency": "USD",
  "settled_net_amount": 1893,
  "transactions_gross_amount": 1900,
  "interchange_gross_amount": -7,
  "disputes_gross_amount": 0,
  "other_fees_gross_amount": 0,
  "details": [
    {
      "network": "MASTERCARD",
      "institution": "00001",
      "settled_net_amount": 1893,
      "transactions_gross_amount": 1900,
      "interchange_gross_amount": -7,
      "disputes_gross_amount": 0,
      "other_fees_gross_amount": 0
    }
  ],
  "report_date": "2023-06-16",
  "created": "2023-06-17T13:00:29.979106",
  "updated": "2023-06-17T13:00:29.979106"
}

Details Endpoint

Field	Change
`settled_gross_amount`	To be removed - renamed to `transactions_gross_amount`
`exception_gross_amount`	To be removed - currently unpopulated
`exception_reason`	To be removed - currently unpopulated

New Details Response

{
  "data": [
    {
      "token": "e34a817f-119d-4976-9fb3-8b020b8bbec3",
      "institution": "00001",
      "account_token": "6c25d6a4-4ff3-46f0-8f9b-f2cbb7e20e09",
      "event_tokens": [
        "8fce9192-41ff-4a7a-8359-bd33b3e0a7c9"
      ],
      "transaction_token": "0e98152b-3753-4a17-bfe2-c6f575c83b85",
      "card_token": "047298ea-5789-46e4-95fa-154aeeab6af3",
      "card_program_token": "62135b36-324f-443a-a630-bab38fe86868",
      "currency": "USD",
      "network": "MASTERCARD",
      "transactions_gross_amount": 1900,
      "interchange_gross_amount": -7,
      "disputes_gross_amount": 0,
      "other_fees_gross_amount": 0,
      "other_fees_details": {},
      "created": "2023-06-17T13:00:29.979106",
      "updated": "2023-06-17T13:00:29.979106",
      "settlement_date": "2023-06-16",
      "report_date": "2023-06-16"
    }
  ],
  "page_size": 1,
  "has_more": true
}