Sign in
Settlements

View validation errors for a Settlement

Retrieve information about failed or partially matched settlements.

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.

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

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

SettlementIdstring required

The unique identifier of the Settlement object.

Query parameters

pageinteger

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

per_pageinteger

Min. value: 1; max. value: 100

Default value: 10

Indicates the number of items returned for each page of the pagination.

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Response

Success

Changes

Changed in 1 of the 8 revisions of this API.23

  • 79528107028523See the full diff
    • ●

      removed the optional property LinesErrors/items/Code from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property LinesErrors/items/Description from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter page

      new-optional-request-parameter

    • ○

      added the new optional query request parameter per_page

      new-optional-request-parameter

    • ○

      added the optional property LinesErrors/items/Details to the response with the 200 status

      response-optional-property-added