Skip to main content

Documentation

List Additional Bank Account Configurations on an Agreement

Retrieve all bank account configurations for a specific agreement, including pending, approved, and declined requests.

    • merchant_id

    • Identifier of merchant.

    • agreement_id

    • Identifier of a specific merchant agreement.

    • api-version

    • The requested API version

      3.0

    • ApiKey

    • Standard Authorization header using the ApiKey scheme.

    • Accept

    • Only application/json is supported.

    • 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.

    • 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.

    • success

    • Indicates whether the request was successful.

    • statusCode

    • The HTTP status code of the response.

    • message

    • Not found.

    • data

    • null

    • 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/list

  • 200

  • curl -X GET
    /isoapi/merchants/{merchant_id}/agreements/{agreement_id}/banks/list
    -H 'ApiKey: my-ApiKey'
    
  • {
      "success": true,
      "statusCode": 200,
      "message": "Success",
      "data": {
        "bankConfigurations": [
          {
            "status": "PENDING",
            "declineReason": "UNKNOWN",
            "bankAccount": {
              "iban": "GB81SAPY60838227567912",
              "swiftNumber": "IFXSGB2L",
              "sortCode": "12-34-56",
              "bankName": "Emirates NBD",
              "owner": {
                "name": "John Doe",
                "address": {
                  "street": "Oxfordstreet 12",
                  "postalCode": "HFJ220",
                  "city": "London",
                  "countryCode": "is"
                }
              }
            }
          }
        ]
      }
    }
  • 400

  • curl -X GET
    /isoapi/merchants/{merchant_id}/agreements/{agreement_id}/banks/list
    -H 'ApiKey: my-ApiKey'
    
  • {
      "success": false,
      "statusCode": 400,
      "message": "Bad request",
      "data": {
        "property": "error message"
      }
    }
  • 401

  • curl -X GET
    /isoapi/merchants/{merchant_id}/agreements/{agreement_id}/banks/list
    -H 'ApiKey: my-ApiKey'
    
  • {
      "success": false,
      "statusCode": 401,
      "message": "Api Key was not provided",
      "data": null
    }
  • 404

  • curl -X GET
    /isoapi/merchants/{merchant_id}/agreements/{agreement_id}/banks/list
    -H 'ApiKey: my-ApiKey'
    
  • {
      "success": false,
      "statusCode": 404,
      "message": "Not Found",
      "data": null
    }
    
  • 500

  • curl -X GET
    /isoapi/merchants/{merchant_id}/agreements/{agreement_id}/banks/list
    -H 'ApiKey: my-ApiKey'
    
  • {
      "success": false,
      "statusCode": 500,
      "message": "Unexpected error occurred. Please contact support.",
      "data": null
    }