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.

Parameters
Request Path Parameters

    • merchant_id

    • Identifier of merchant.

    • agreement_id

    • Identifier of a specific merchant agreement.

Request Query Parameters

    • status

    • Filter results by bank account status. Accepted values: APPROVED, PENDING, DECLINED. Can be specified multiple times to filter by more than one status. Accepts either comma-separated values (status=PENDING,DECLINED) or repeated parameters (status=PENDING&status=DECLINED).

Request Header Parameters

    • api-version

    • The requested API version

      3.0

    • ApiKey

    • Standard Authorization header using the ApiKey scheme.

    • Accept

    • Only application/json is supported.

200 Success 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.

400 Bad Request Response

    • success

    • Indicates whether the request was successful.

    • statusCode

    • The HTTP status code of the response.

    • message

    • Bad request.

    • data

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

  • 200 Success

  • 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"
            }
          }
        }
      }
    ]
  }
}

  • 200 Success (filtered by status)

  • curl -X GET
'/isoapi/merchants/{merchant_id}/agreements/{agreement_id}/banks/list?status=PENDING&status=DECLINED'
-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"
            }
          }
        }
      },
      {
        "status": "DECLINED",
        "declineReason": "INVALID_ACCOUNT",
        "bankAccount": {
          "iban": "GB29NWBK60161331926819",
          "swiftNumber": "NWBKGB2L",
          "sortCode": "60-16-13",
          "bankName": "NatWest",
          "owner": {
            "name": "Jane Smith",
            "address": {
              "street": "Baker Street 221B",
              "postalCode": "NW1 6XE",
              "city": "London",
              "countryCode": "gb"
            }
          }
        }
      }
    ]
  }
}

  • 400 Bad Request

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

  • 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 Not Found

  • 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 Internal Server Error

  • 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
}
In this section: