View validation errors for a Settlement

Retrieve information about failed or partially matched settlements

GET /v3.0/{ClientId}/payins/intents/settlements/{SettlementId}/validations

REST

// GET has no body parameters

200

{
  "FooterErrors": [
    {
      "FooterName": "TotalNetSettlementAmount",
      "Code": "SETTLEMENTAMOUNT_NOT_MATCH",
      "Description": "TotalNetSettlement amount 1000 EUR is not matching to declared amount 9000 EUR."
    }
  ],
  "LinesErrors": [
    {
      "ExternalProviderReference": "auth-stripe-76f0baab-3d89-47e4-85f6-417864588055",
      "ExternalTransactionType": "REFUND",
      "Code": "MATCH_REF_NOT_FOUND",
      "Description": "ExternalProviderReference not found for any existing Intent in the system"
    }
  ]
}

If your Settlement’s Status is PARTIALLY_MATCHED or FAILED, this endpoint returns information about the errors in your CSV file’s footer or transaction lines.

Path parameters

SettlementId · string · required

The unique identifier of the Settlement object.

Responses

200 - OK

FooterErrors · array (object)

The errors encountered in the CSV footer.

Show properties

FooterName · string

The footer line which produced the error.

Code · string

The type of error encountered.

Description · string

A description of the error.

LinesErrors · array (object)

The errors encountered in the CSV’s transaction lines.

Show properties

ExternalProviderReference · string

The unique identifier of the transaction at the provider level.

ExternalTransactionType · string

Response values: PAYMENT, REFUND, DISPUTE

The type of the transaction.

Code · string

The type of error encountered.

Description · string

A description of the error.

200

{
  "FooterErrors": [
    {
      "FooterName": "TotalNetSettlementAmount",
      "Code": "SETTLEMENTAMOUNT_NOT_MATCH",
      "Description": "TotalNetSettlement amount 1000 EUR is not matching to declared amount 9000 EUR."
    }
  ],
  "LinesErrors": [
    {
      "ExternalProviderReference": "auth-stripe-76f0baab-3d89-47e4-85f6-417864588055",
      "ExternalTransactionType": "REFUND",
      "Code": "MATCH_REF_NOT_FOUND",
      "Description": "ExternalProviderReference not found for any existing Intent in the system"
    }
  ]
}

REST

// GET has no body parameters