Skip to main content

Documentación

Update Bank Account

Update the merchant’s bank account details for a specific agreement.

Parameters
Request Path Parameters

    • merchant_id

    • Identifier of merchant.

    • agreement_id

    • Identifier of a specific merchant agreement.

Request Header Parameters

    • api-version

    • The requested API version

      3.0

    • ApiKey

    • Standard Authorization header using the ApiKey scheme.

    • Content-Type

    • Only application/json is supported.

Request Body Parameters

    • bankAccount

    • The bank account details to update for the agreement.

200 OK Response

    • success

    • Indicates whether the request was successful.

    • statusCode

    • The HTTP status code of the response.

    • message

    • Success

    • data

    • Object includes the following parameters:

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

    • null

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.

    • data

    • null.

  • /isoapi/merchants/:merchant_id/agreements/:agreement_id/banks

  • 200 Success

  • curl -X POST
https://boarding.valitor.com/isoapi/merchants/1204763/agreements/808706/banks  
-H 'ApiKey: my-ApiKey'
-H 'Content-Type: application/json'
-d' {
  "bankAccount": {
    "name": "string",
    "owner": {
      "name": "Jane Doe",
      "address": {
        "street": "2nd street",
        "postalCode": "02000",
        "city": "Anytown",
        "countryCode": "GB"
      }
    },
    "bankName": "ADCB",
    "accountNumber": "27567902",
    "iban": "GB81SAPY60838227567902",
    "swiftNumber": "IFXSGB2L",
    "sortCode": "12-34-56",
    "ownerNationalIdNumber": "76576",
    "bankAccountConfirmed": true,
    "bankAccountConfirmationAttachment": {
      "file": "iVBORw0KGgoAAAANSU2xqanFubkhERbW0tMGvFOEaIv/mACQ",
      "fileName": "sample.pdf"
    }
  }
}  

  • {
  "success": true,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "bankConfiguration": {
      "accountNumber": "27567902",
      "iban": "GB81SAPY60838227567902",
      "status": "PENDING"
    }
  }
}

  • 400 Bad Request

  • curl -X POST
https://boarding.valitor.com/isoapi/merchants/1204763/agreements/808706/banks  
-H 'Content-Type: my-Content-Type'
--header 'ApiKey: Your API key here' 
--header 'Content-Type: application/json'
--header 'Accept: application/json'
-d' {
  "bankAccount": {
    "name": "string",
    "owner": {
      "name": "Jane Doe",
      "address": {
        "street": "2nd street",
        "postalCode": "02000",
        "city": "Anytown",
        "countryCode": "GB"
      }
    },
    "bankName": "ADCB",
    "accountNumber": "27567902",
    "iban": "GB81SAPY60838227567902",
    "swiftNumber": "IFXSGB2L",
    "sortCode": "12-34-56",
    "ownerNationalIdNumber": "76576",
    "bankAccountConfirmed": true,
    "bankAccountConfirmationAttachment": {
      "file": "iVBORw0KGgoAAAANSU2xqanFubkhERbW0tMGvFOEaIv/mACQ",
      "fileName": "sample.pdf"
    }
  }
}  

  • {
  "success": false,
  "statusCode": 400,
  "message": "Bad request",
  "data": {
    "property": "error message"
  }
}

  • 401 Unauthorized

  • curl -X POST
https://boarding.valitor.com/isoapi/merchants/1204763/agreements/808706/banks  
-H 'Content-Type: my-Content-Type'
--header 'ApiKey: Your API key here' 
--header 'Content-Type: application/json'
--header 'Accept: application/json'
-d' {
  "bankAccount": {
    "name": "string",
    "owner": {
      "name": "Jane Doe",
      "address": {
        "street": "2nd street",
        "postalCode": "02000",
        "city": "Anytown",
        "countryCode": "GB"
      }
    },
    "bankName": "ADCB",
    "accountNumber": "27567902",
    "iban": "GB81SAPY60838227567902",
    "swiftNumber": "IFXSGB2L",
    "sortCode": "12-34-56",
    "ownerNationalIdNumber": "76576",
    "bankAccountConfirmed": true,
    "bankAccountConfirmationAttachment": {
      "file": "iVBORw0KGgoAAAANSU2xqanFubkhERbW0tMGvFOEaIv/mACQ",
      "fileName": "sample.pdf"
    }
  }
}  

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

  • 404 Not Found

  • curl -X POST
https://boarding.valitor.com/isoapi/merchants/1204763/agreements/808706/banks  
-H 'Content-Type: my-Content-Type'
--header 'ApiKey: Your API key here' 
--header 'Content-Type: application/json'
--header 'Accept: application/json'
-d' {
  "bankAccount": {
    "name": "string",
    "owner": {
      "name": "Jane Doe",
      "address": {
        "street": "2nd street",
        "postalCode": "02000",
        "city": "Anytown",
        "countryCode": "GB"
      }
    },
    "bankName": "ADCB",
    "accountNumber": "27567902",
    "iban": "GB81SAPY60838227567902",
    "swiftNumber": "IFXSGB2L",
    "sortCode": "12-34-56",
    "ownerNationalIdNumber": "76576",
    "bankAccountConfirmed": true,
    "bankAccountConfirmationAttachment": {
      "file": "iVBORw0KGgoAAAANSU2xqanFubkhERbW0tMGvFOEaIv/mACQ",
      "fileName": "sample.pdf"
    }
  }
}  

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

  • 500 Server Error

  • curl -X POST
https://boarding.valitor.com/isoapi/merchants/1204763/agreements/808706/banks  
-H 'Content-Type: my-Content-Type'
--header 'ApiKey: Your API key here' 
--header 'Content-Type: application/json'
--header 'Accept: application/json'
-d' {
  "bankAccount": {
    "name": "string",
    "owner": {
      "name": "Jane Doe",
      "address": {
        "street": "2nd street",
        "postalCode": "02000",
        "city": "Anytown",
        "countryCode": "GB"
      }
    },
    "bankName": "ADCB",
    "accountNumber": "27567902",
    "iban": "GB81SAPY60838227567902",
    "swiftNumber": "IFXSGB2L",
    "sortCode": "12-34-56",
    "ownerNationalIdNumber": "76576",
    "bankAccountConfirmed": true,
    "bankAccountConfirmationAttachment": {
      "file": "iVBORw0KGgoAAAANSU2xqanFubkhERbW0tMGvFOEaIv/mACQ",
      "fileName": "sample.pdf"
    }
  }
}  

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