Skip to main content

Documentación

Get Bank Account Configuration of an agreement

Retrieves the current bank account configuration for a given merchant agreement, allowing ISO partners to verify the current state without relying on the client portal UI.

Parameters
Request Path Parameters

    • merchant_id

    • The Valitor merchant ID.

    • agreement_id

    • The Valitor agreement ID.

Request Header Parameters

    • api-version

    • The requested API version

      3.0

    • ApiKey

    • Standard Authorization header using the ApiKey scheme.

200 OK Response

    • success

    • Indicates whether the request was successful.

    • statusCode

    • The HTTP status code of the response.

    • message

    • A human-readable message describing the result.

    • data

    • An object containing the bank account configuration.

401 Unauthorized Response

    • success

    • Indicates whether the request was successful.

    • statusCode

    • The HTTP status code of the response.

    • message

    • Api Key was not provided.

    • data

    • No data is returned for unauthorized requests.

404 Not Found Response

    • success

    • Indicates whether the request was successful.

    • statusCode

    • The HTTP status code of the response.

    • message

    • Not found.

    • data

    • null

500 Internal Server Error Response

    • success

    • Indicates whether the request was successful.

    • statusCode

    • The HTTP status code of the response.

    • message

    • Unexpected error occurred. Please contact support.

    • data

    • null

  • /isoapi/merchants/{merchant_id}/agreements/{agreement_id}/banks

  • 200 OK

  • curl -X GET
https://boarding.valitor.com/isoapi/merchants/{merchant_id}/agreements/{agreement_id}/banks
-H 'ApiKey: my-ApiKey'

  • {
  "success": true,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "bankConfiguration": {
      "status": "PENDING",
      "owner": {
        "name": "John Doe",
        "address": {
          "street": "Oxfordstreet 12",
          "postalCode": "HFJ220",
          "city": "London",
          "countryCode": "is"
        }
      },
      "bankName": "Sample Bank",
      "iban": "IBAN123456789",
      "swiftNumber": "SWIFT123456",
      "sortCode": "12-34-56"
    }
  }
}

  • 401 Unauthorized

  • curl -X GET
https://boarding.valitor.com/isoapi/merchants/{merchant_id}/agreements/{agreement_id}/banks
-H 'ApiKey: my-ApiKey'

  • {
  "success": false,
  "statusCode": 401,
  "message": "Api Key was not provided",
  "data": null
}

  • 404 Not Found

  • curl -X GET
https://boarding.valitor.com/isoapi/merchants/{merchant_id}/agreements/{agreement_id}/banks
-H 'ApiKey: my-ApiKey'

  • {
  "success": false,
  "statusCode": 404,
  "message": "Not Found",
  "data": null
}

  • 500 Internal Server Error

  • curl -X GET
https://boarding.valitor.com/isoapi/merchants/{merchant_id}/agreements/{agreement_id}/banks
-H 'ApiKey: my-ApiKey'

  • {
  "success": false,
  "statusCode": 500,
  "message": "Unexpected error occured. Please contact support.",
  "data": null
}
En esta sección: